basePath: / consumes: - application/json definitions: 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: access_group_id: type: string x-go-name: AccessGroupId description: type: string x-go-name: Description priority: format: int64 type: integer x-go-name: Priority rw_access_type: type: string x-go-name: RWAccessType source: type: string x-go-name: Source user_access_type: type: string x-go-name: UserAccessType 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 x-go-name: Description priority: format: int64 type: integer x-go-name: Priority rw_access_type: type: string x-go-name: RWAccessType source: type: string x-go-name: Source user_access_type: type: string x-go-name: UserAccessType type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute AiGatewayChangeConfigOptions: properties: Authentication: type: boolean CacheInvalidateOnUpdate: type: boolean CacheTTL: format: int64 type: integer CollectLogs: type: boolean RateLimitingInterval: format: int64 type: integer RateLimitingLimit: format: int64 type: integer RateLimitingTechnique: type: string type: object x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider AiGatewayCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata authentication: type: boolean x-go-name: Authentication cache_invalidate_on_update: type: boolean x-go-name: CacheInvalidateOnUpdate cache_ttl: format: int64 type: integer x-go-name: CacheTTL cloudprovider_id: description: 列出关联指定云订阅(ID或Name)的资源 type: string x-go-name: CloudproviderId collect_logs: type: boolean x-go-name: CollectLogs 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 rate_limiting_interval: format: int64 type: integer x-go-name: RateLimitingInterval rate_limiting_limit: format: int64 type: integer x-go-name: RateLimitingLimit rate_limiting_technique: type: string x-go-name: RateLimitingTechnique status: description: 用来存储资源的状态 type: string x-go-name: Status required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute AiGatewayDetails: 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 AiGatewayUpdateInput: 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 AppBackup: properties: id: type: string x-go-name: Id name: type: string x-go-name: Name type: type: string x-go-name: Type type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute AppBackupOutput: properties: backup_config: properties: enabled: type: boolean x-go-name: Enabled frequency_interval: format: int64 type: integer x-go-name: FrequencyInterval frequency_unit: type: string x-go-name: FrequencyUnit retention_period_in_days: format: int64 type: integer x-go-name: RetentionPeriodInDays type: object x-go-name: BackupConfig data: items: $ref: '#/definitions/AppBackup' type: array x-go-name: Data type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute AppCertificate: properties: expire_time: format: date-time type: string x-go-name: ExpireTime id: type: string x-go-name: Id issue_date: format: date-time type: string x-go-name: IssueDate issuer: type: string x-go-name: Issuer name: type: string x-go-name: Name subject_name: type: string x-go-name: SubjectName thumbprint: type: string x-go-name: Thumbprint type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute AppCertificateOutput: properties: data: items: $ref: '#/definitions/AppCertificate' type: array x-go-name: Data 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 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 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: type: string x-go-name: Vpc vpc_id: type: string x-go-name: VpcId type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute AppDomain: properties: id: type: string x-go-name: Id name: type: string x-go-name: Name ssl_state: type: string x-go-name: SslState status: type: string x-go-name: Status type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute AppDomainOutput: properties: data: items: $ref: '#/definitions/AppDomain' type: array x-go-name: Data 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 AppHybirdConnection: properties: hostname: type: string x-go-name: Hostname id: type: string x-go-name: Id name: type: string x-go-name: Name namespace: type: string x-go-name: Namespace port: format: int64 type: integer x-go-name: Port type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute AppHybirdConnectionOutput: properties: data: items: $ref: '#/definitions/AppHybirdConnection' type: array x-go-name: Data 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_bucket_url_ext: description: 'description: external access url of object storage bucket' type: string x-go-name: ObjectBucketUrlExt object_secret: description: 'description: secret of object storage' type: string x-go-name: ObjectSecret object_sign_ver: description: 'description: signing version, can be v2/v4, default is v4' type: string x-go-name: ObjectSignVer 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_bucket_url_ext: description: 'description: external access url of object storage bucket' type: string x-go-name: ObjectBucketUrlExt object_secret: description: 'description: secret of object storage' type: string x-go-name: ObjectSecret object_sign_ver: description: 'description: signing version, can be v2/v4, default is v4' type: string x-go-name: ObjectSignVer 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_bucket_url_ext: description: 'description: external access url of object storage bucket' type: string x-go-name: ObjectBucketUrlExt object_secret: description: 'description: secret of object storage' type: string x-go-name: ObjectSecret object_sign_ver: description: 'description: signing version, can be v2/v4, default is v4' type: string x-go-name: ObjectSignVer 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 soft_raid_idx: format: int64 type: integer x-go-name: SoftRaidIdx 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 BaremetalRootDiskMatcher: properties: device: type: string x-go-name: Device pci_path: type: string x-go-name: PCIPath size_mb: format: int64 type: integer x-go-name: SizeMB size_mb_range: $ref: '#/definitions/RootDiskMatcherSizeMBRange' 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 BatchConvertToKvmCheckInput: properties: guest_ids: items: type: string type: array x-go-name: GuestIds type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute BucketAclInput: properties: Acl: $ref: '#/definitions/TBucketACLType' key: items: type: string type: array x-go-name: Key type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute BucketCORSRule: properties: allowed_headers: items: type: string type: array x-go-name: AllowedHeaders allowed_methods: items: type: string type: array x-go-name: AllowedMethods allowed_origins: description: 允许的源站，可以是* items: type: string type: array x-go-name: AllowedOrigins expose_headers: items: type: string type: array x-go-name: ExposeHeaders id: description: 规则区别标识 type: string x-go-name: Id max_age_seconds: format: int64 type: integer x-go-name: MaxAgeSeconds type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute BucketCORSRuleDeleteInput: properties: id: items: type: string type: array x-go-name: Id 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 enable_perf_mon: type: boolean x-go-name: EnablePerfMon 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 enable_perf_mon: type: boolean x-go-name: EnablePerfMon 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: Metadata: $ref: '#/definitions/Header' key: items: type: string type: array x-go-name: Key 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 x-go-name: Data type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute BucketPolicyDeleteInput: properties: id: items: type: string type: array x-go-name: Id type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute BucketPolicyStatement: properties: Action: description: 授权的行为 items: type: string type: array Condition: additionalProperties: additionalProperties: {} type: object description: 触发授权的条件 type: object Effect: description: Allow|Deny type: string Principal: additionalProperties: items: type: string type: array description: 授权的目标主体 type: object Resource: description: 被授权的资源地址 items: type: string type: array canned_action: description: Read|ReadWrite|FullControl type: string x-go-name: CannedAction id: description: 根据index 生成 type: string x-go-name: Id principal_id: description: 解析字段，主账号id:子账号id items: type: string type: array x-go-name: PrincipalId principal_names: additionalProperties: type: string description: map[主账号id:子账号id]子账号name type: object x-go-name: PrincipalNames resource_path: description: 资源路径 items: type: string type: array x-go-name: ResourcePath type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute BucketPolicyStatementInput: properties: canned_action: description: Read|ReadWrite|FullControl type: string x-go-name: CannedAction effect: description: Allow|Deny type: string x-go-name: Effect ip_equals: description: ip 条件 items: type: string type: array x-go-name: IpEquals ip_not_equals: items: type: string type: array x-go-name: IpNotEquals principal_id: description: 主账号id:子账号id items: type: string type: array x-go-name: PrincipalId resource_path: description: 被授权的资源地址,/* items: type: string type: array x-go-name: ResourcePath type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute BucketRefererConf: properties: allow_empty_refer: description: 是否允许空referer 访问 type: boolean x-go-name: AllowEmptyRefer domain_list: description: 域名列表 items: type: string type: array x-go-name: DomainList enabled: description: 是否开启 type: boolean x-go-name: Enabled referer_type: description: |- Referer Type enmu: Black-List, White-List type: string x-go-name: RefererType 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 enable_perf_mon: type: boolean x-go-name: EnablePerfMon 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: error_document: description: 错误时返回的文档 type: string x-go-name: ErrorDocument index: description: 主页 type: string x-go-name: Index protocol: description: http或https type: string x-go-name: Protocol rules: items: $ref: '#/definitions/BucketWebsiteRoutingRule' type: array x-go-name: Rules url: description: 访问网站url type: string x-go-name: Url type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute BucketWebsiteRoutingRule: properties: condition_error_code: type: string x-go-name: ConditionErrorCode condition_prefix: type: string x-go-name: ConditionPrefix redirect_protocol: type: string x-go-name: RedirectProtocol redirect_replace_key: type: string x-go-name: RedirectReplaceKey redirect_replace_key_prefix: type: string x-go-name: RedirectReplaceKeyPrefix 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 CDNCustomHostnameOutput: properties: data: items: $ref: '#/definitions/CustomHostname' type: array x-go-name: Data type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute CDNDeleteCustomHostnameInput: properties: id: type: string x-go-name: Id 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 CacheClearOptions: properties: Files: items: {} type: array Hosts: items: type: string type: array Prefixes: items: type: string type: array PurgeEverything: type: boolean Tags: items: type: string type: array type: object x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider CacheConfig: properties: BrowserCacheTTL: format: int64 type: integer CacheLevel: type: string DNSSECEnabled: type: boolean HTTPSEnabled: type: boolean HTTPSRewrites: type: boolean SSLSetting: type: string type: object x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider CacheImageInput: properties: format: type: string x-go-name: Format image_id: type: string x-go-name: ImageId is_force: type: boolean x-go-name: IsForce type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute CachedImageManagerCacheImageInput: properties: auto_cache: type: boolean x-go-name: AutoCache host_tags: $ref: '#/definitions/STagFilters' host_type: items: type: string type: array x-go-name: HostType image_id: type: string x-go-name: ImageId storage_tags: $ref: '#/definitions/STagFilters' storage_type: items: type: string type: array x-go-name: StorageType 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 x-go-name: Area cname: description: cdn Cname type: string x-go-name: Cname domain: description: cdn加速域名 type: string x-go-name: Domain origin: description: 源站 type: string x-go-name: Origin origin_type: description: 源站类型 domain|ip|bucket type: string x-go-name: OriginType status: description: 状态 rejected(域名未审核)|processing(部署中)|online|offline type: string x-go-name: Status 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 name: type: string x-go-name: Name 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 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 RegionId: 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 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 | 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_auto_sync_resource: type: boolean x-go-name: EnableAutoSyncResource 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_duplicate_account_check: description: 跳过重复账号注册检查 type: boolean x-go-name: SkipDuplicateAccountCheck 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 type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute CloudaccountDetail: properties: 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相同 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_auto_sync_resource: type: boolean x-go-name: EnableAutoSyncResource 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_cost: description: 上次同步耗时 type: string x-go-name: LastSyncCost 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: type: string x-go-name: ProjectMapping 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 region_id: description: 云平台默认区域id type: string x-go-name: RegionId 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_status2: 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-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 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 RegionId: 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 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 | 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_auto_sync_resource: type: boolean x-go-name: EnableAutoSyncResource 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_duplicate_account_check: description: 跳过重复账号注册检查 type: boolean x-go-name: SkipDuplicateAccountCheck 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 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 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-package: yunion.io/x/onecloud/pkg/apis/compute CloudaccountShareModeInput: properties: share_mode: type: string x-go-name: ShareMode type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute CloudaccountSyncSkusInput: properties: cloudprovider_id: description: 列出关联指定云订阅(ID或Name)的资源 type: string x-go-name: CloudproviderId cloudregion_id: description: 区域名称或ID type: string x-go-name: CloudregionId force: type: boolean x-go-name: Force resource: type: string x-go-name: Resource type: object 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 enable_auto_sync_resource: type: boolean x-go-name: EnableAutoSyncResource 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-package: yunion.io/x/onecloud/pkg/apis/compute CloudproviderDetails: properties: 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_cost: description: 上次同步耗时 type: string x-go-name: LastSyncCost 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: type: string x-go-name: ProjectMapping 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-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: can_delete: description: 资源是否可以删除, 若为flase, delete_fail_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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 CloudregionPurgeInput: properties: manager_id: description: 云订阅Id, 若region底下不存在任何资源,会删除当前region type: string x-go-name: ManagerId required: - manager_id 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 ContainerCDIKind: type: string x-go-package: yunion.io/x/onecloud/pkg/apis 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 ContainerCommitExternalRegistry: properties: auth: $ref: '#/definitions/ContainerPullImageAuthConfig' url: description: 'e.g.: registry.cn-beijing.aliyuncs.com/yunionio' type: string x-go-name: Url type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerCommitInput: properties: external_registry: $ref: '#/definitions/ContainerCommitExternalRegistry' image_name: description: image name type: string x-go-name: ImageName registry_id: description: Container registry id from kubeserver type: string x-go-name: RegistryId tag: description: image tag type: string x-go-name: Tag type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerCommitOutput: properties: repository: type: string x-go-name: Repository type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata auto_start: type: boolean x-go-name: AutoStart 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-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 ContainerExecSyncInput: properties: command: items: type: string type: array x-go-name: Command timeout: default: 0 description: Timeout in seconds to stop the command, 0 mean run forever. format: int64 type: integer x-go-name: Timeout 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: cdi: $ref: '#/definitions/ContainerIsolatedDeviceCDI' id: type: string x-go-name: Id index: format: int64 type: integer x-go-name: Index only_env: items: $ref: '#/definitions/ContainerIsolatedDeviceOnlyEnv' type: array x-go-name: OnlyEnv type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerIsolatedDeviceCDI: properties: Kind: $ref: '#/definitions/ContainerCDIKind' type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerIsolatedDeviceOnlyEnv: properties: from_device_minor: type: boolean x-go-name: FromDeviceMinor from_index: type: boolean x-go-name: FromIndex from_render_path: type: boolean x-go-name: FromRenderPath key: type: string x-go-name: Key type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerKeyValue: properties: key: type: string x-go-name: Key value: type: string x-go-name: Value value_from: $ref: '#/definitions/ContainerValueSource' 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-package: yunion.io/x/onecloud/pkg/apis ContainerMountPropagation: type: string x-go-package: yunion.io/x/onecloud/pkg/apis ContainerPerformStatusInput: properties: host_id: description: call from host id type: string x-go-name: HostId last_finished_at: format: date-time type: string x-go-name: LastFinishedAt power_states: description: 电源状态 type: string x-go-name: PowerStates reason: description: 更改状态的原因描述 type: string x-go-name: Reason restart_count: format: int64 type: integer x-go-name: RestartCount started_at: format: date-time type: string x-go-name: StartedAt status: description: 更改的目标状态值 type: string x-go-name: Status required: - status type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerProbe: description: |- ContainerProbe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. properties: exec: $ref: '#/definitions/ContainerProbeHandlerExecAction' failure_threshold: description: |- Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. format: int32 type: integer x-go-name: FailureThreshold http_get: $ref: '#/definitions/ContainerProbeHTTPGetAction' period_seconds: description: |- How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. format: int32 type: integer x-go-name: PeriodSeconds success_threshold: description: |- Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. format: int32 type: integer x-go-name: SuccessThreshold tcp_socket: $ref: '#/definitions/ContainerProbeTCPSocketAction' timeout_seconds: description: |- Number of seconds after the container has started before liveness probes are initiated. InitialDelaySeconds int32 `json:"initial_delay_seconds,omitempty"` Number of seconds after which the probe times out. format: int32 type: integer x-go-name: TimeoutSeconds type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerProbeHTTPGetAction: properties: host: description: |- Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional type: string x-go-name: Host httpHeaders: description: |- Custom headers to set in the request. HTTP allows repeated headers. +optional items: $ref: '#/definitions/HTTPHeader' type: array x-go-name: HTTPHeaders path: description: |- Path to access on the HTTP server. +optional type: string x-go-name: Path port: description: |- Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. format: int64 type: integer x-go-name: Port scheme: $ref: '#/definitions/URIScheme' title: ContainerProbeHTTPGetAction describes an action based on HTTP Get requests. type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerProbeHandlerExecAction: properties: command: description: |- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional items: type: string type: array x-go-name: Command title: ContainerProbeHandlerExecAction describes a "run in container" action. type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerProbeTCPSocketAction: description: ContainerProbeTCPSocketAction describes an action based on opening a socket properties: host: description: |- Optional: Host name to connect to, defaults to the pod IP. +optional type: string x-go-name: Host port: description: |- Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. format: int64 type: integer x-go-name: Port type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerProcMountType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis ContainerPullImageAuthConfig: properties: auth: type: string x-go-name: Auth identity_token: description: |- IdentityToken is used to authenticate the user and get an access token for the registry. type: string x-go-name: IdentityToken password: type: string x-go-name: Password registry_token: description: RegistryToken is a bearer token to be sent to a registry type: string x-go-name: RegistryToken server_address: type: string x-go-name: ServerAddress username: type: string x-go-name: Username type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerResources: properties: cpu_cfs_quota: description: CpuCfsQuota can be set to 0.5 that mapping to 0.5*100000 for cpu.cpu_cfs_quota_us format: double type: number x-go-name: CpuCfsQuota cpuset_clone_children: description: |- This flag only affects the cpuset controller. If the clone_children flag is enabled in a cgroup, a new cpuset cgroup will copy its configuration fromthe parent during initialization. type: boolean x-go-name: CpusetCloneChildren devices_allow: description: DevicesAllow will be set to devices.allow items: type: string type: array x-go-name: DevicesAllow memory_high_ratio: description: cgroup memory.high format: double type: number x-go-name: MemoryHighRatio pids_max: description: |- MemoryLimitMB will be transferred to memory.limit_in_bytes MemoryLimitMB *int64 `json:"memory_limit_mb,omitempty"` PidsMax will be set to pids.max format: int64 type: integer x-go-name: PidsMax type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerResourcesSetInput: properties: cpu_cfs_quota: description: CpuCfsQuota can be set to 0.5 that mapping to 0.5*100000 for cpu.cpu_cfs_quota_us format: double type: number x-go-name: CpuCfsQuota cpuset_clone_children: description: |- This flag only affects the cpuset controller. If the clone_children flag is enabled in a cgroup, a new cpuset cgroup will copy its configuration fromthe parent during initialization. type: boolean x-go-name: CpusetCloneChildren devices_allow: description: DevicesAllow will be set to devices.allow items: type: string type: array x-go-name: DevicesAllow disable_limit_check: type: boolean x-go-name: DisableLimitCheck memory_high_ratio: description: cgroup memory.high format: double type: number x-go-name: MemoryHighRatio pids_max: description: |- MemoryLimitMB will be transferred to memory.limit_in_bytes MemoryLimitMB *int64 `json:"memory_limit_mb,omitempty"` PidsMax will be set to pids.max format: int64 type: integer x-go-name: PidsMax type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerRestartInput: properties: force: type: boolean x-go-name: Force timeout: format: int64 type: integer x-go-name: Timeout type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerRootfs: properties: disk: $ref: '#/definitions/ContainerVolumeMountDisk' persistent: description: 是否持久化 type: boolean x-go-name: Persistent type: $ref: '#/definitions/ContainerVolumeMountType' type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerSaveVolumeMountToImageInput: properties: exclude_paths: items: type: string type: array x-go-name: ExcludePaths image_id: type: string x-go-name: ImageId volume_mount: $ref: '#/definitions/ContainerVolumeMount' volume_mount_dirs: items: type: string type: array x-go-name: VolumeMountDirs volume_mount_index: format: int64 type: integer x-go-name: VolumeMountIndex volume_mount_prefix: type: string x-go-name: VolumeMountPrefix type: object x-go-package: yunion.io/x/onecloud/pkg/apis/host ContainerSecurityContext: properties: apparmor_profile: type: string x-go-name: ApparmorProfile proc_mount: $ref: '#/definitions/ContainerProcMountType' run_as_group: format: int64 type: integer x-go-name: RunAsGroup run_as_user: format: int64 type: integer x-go-name: RunAsUser type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerSpec: properties: always_restart: type: boolean x-go-name: AlwaysRestart 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 cgroup_pids_max: format: int64 type: integer x-go-name: CgroupPidsMax command: description: Command to execute (i.e., entrypoint for docker) items: type: string type: array x-go-name: Command depends_on: description: |- DependsOn is a list of container name which this container depends on when pod start Only works for containers created & started by pod-create & server-start items: type: string type: array x-go-name: DependsOn devices: items: $ref: '#/definitions/ContainerDevice' type: array x-go-name: Devices disable_no_new_privs: type: boolean x-go-name: DisableNoNewPrivs 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_credential_id: description: Image credential id type: string x-go-name: ImageCredentialId image_pull_policy: $ref: '#/definitions/ImagePullPolicy' lifecyle: $ref: '#/definitions/ContainerLifecyle' primary: type: boolean x-go-name: Primary privileged: type: boolean x-go-name: Privileged resources_limit: $ref: '#/definitions/ContainerResources' rootfs: $ref: '#/definitions/ContainerRootfs' security_context: $ref: '#/definitions/ContainerSecurityContext' shm_size_mb: format: int64 type: integer x-go-name: ShmSizeMB simulate_cpu: type: boolean x-go-name: SimulateCpu startup_probe: $ref: '#/definitions/ContainerProbe' 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: force: type: boolean x-go-name: Force timeout: format: int64 type: integer x-go-name: Timeout type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerValueSource: properties: credential: $ref: '#/definitions/ContainerValueSourceCredential' type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerValueSourceCredential: properties: id: type: string x-go-name: Id key: type: string x-go-name: Key type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerVolumeMount: properties: ceph_fs: $ref: '#/definitions/ContainerVolumeMountCephFS' disk: $ref: '#/definitions/ContainerVolumeMountDisk' fs_group: format: int64 type: integer x-go-name: FsGroup fs_user: format: int64 type: integer x-go-name: FsUser 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 text: $ref: '#/definitions/ContainerVolumeMountText' type: $ref: '#/definitions/ContainerVolumeMountType' unique_name: description: 用于标识当前 pod volume mount 的唯一性 type: string x-go-name: UniqueName type: object x-go-package: yunion.io/x/onecloud/pkg/apis/host ContainerVolumeMountAddPostOverlayInput: properties: index: format: int64 type: integer x-go-name: Index post_overlay: items: $ref: '#/definitions/ContainerVolumeMountDiskPostOverlay' type: array x-go-name: PostOverlay type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerVolumeMountCephFS: properties: id: type: string x-go-name: Id mon_host: type: string x-go-name: MonHost name: type: string x-go-name: Name path: type: string x-go-name: Path secret: type: string x-go-name: Secret type: object x-go-package: yunion.io/x/onecloud/pkg/apis/host ContainerVolumeMountDisk: properties: case_insensitive_paths: items: type: string type: array x-go-name: CaseInsensitivePaths id: type: string x-go-name: Id index: format: int64 type: integer x-go-name: Index overlay: $ref: '#/definitions/ContainerVolumeMountDiskOverlay' post_overlay: items: $ref: '#/definitions/ContainerVolumeMountDiskPostOverlay' type: array x-go-name: PostOverlay res_gid: format: int64 type: integer x-go-name: ResGid res_uid: format: int64 type: integer x-go-name: ResUid 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 ContainerVolumeMountDiskPostImageOverlay: properties: host_lower_map: additionalProperties: $ref: '#/definitions/HostLowerPath' description: 宿主机底层目录映射, key 为 PathMap 的 key，value 为 overlay lower 格式，多目录以 ":" 分隔 type: object x-go-name: HostLowerMap id: type: string x-go-name: Id path_map: additionalProperties: type: string type: object x-go-name: PathMap upper_config: $ref: '#/definitions/PostOverlayUpperConfig' type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerVolumeMountDiskPostOverlay: properties: container_target_dir: description: 合并后要挂载到容器的目录 type: string x-go-name: ContainerTargetDir flatten_layers: type: boolean x-go-name: FlattenLayers fs_group: format: int64 type: integer x-go-name: FsGroup fs_user: format: int64 type: integer x-go-name: FsUser host_lower_dir: description: 宿主机底层目录 items: type: string type: array x-go-name: HostLowerDir host_upper_dir: description: 宿主机上层目录 type: string x-go-name: HostUpperDir image: $ref: '#/definitions/ContainerVolumeMountDiskPostImageOverlay' type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerVolumeMountHostPath: properties: auto_create: type: boolean x-go-name: AutoCreate auto_create_config: $ref: '#/definitions/ContainerVolumeMountHostPathAutoCreateConfig' path: type: string x-go-name: Path type: $ref: '#/definitions/ContainerVolumeMountHostPathType' type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerVolumeMountHostPathAutoCreateConfig: properties: gid: format: uint64 type: integer x-go-name: Gid permissions: type: string x-go-name: Permissions uid: format: uint64 type: integer x-go-name: Uid type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerVolumeMountHostPathType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis ContainerVolumeMountRemovePostOverlayInput: properties: clear_layers: type: boolean x-go-name: ClearLayers index: format: int64 type: integer x-go-name: Index post_overlay: items: $ref: '#/definitions/ContainerVolumeMountDiskPostOverlay' type: array x-go-name: PostOverlay use_lazy: type: boolean x-go-name: UseLazy type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ContainerVolumeMountText: properties: content: type: string x-go-name: Content type: object x-go-package: yunion.io/x/onecloud/pkg/apis ContainerVolumeMountType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis ConvertToKvmInput: properties: deploy_telegraf: description: deploy telegraf after convert type: boolean x-go-name: DeployTelegraf 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 CustomHostname: properties: CustomOriginServer: type: string Hostname: type: string Id: type: string OwnershipVerification: properties: Name: type: string Type: type: string Value: type: string type: object OwnershipVerificationHttp: properties: HttpBody: type: string HttpUrl: type: string type: object SSL: properties: BundleMethod: type: string CertificateAuthority: type: string DcvDelegationRecords: items: properties: Cname: type: string CnameTarget: type: string type: object type: array Id: type: string Method: type: string Settings: properties: min_tls_version: type: string x-go-name: MinTLSVersion type: object Status: type: string Type: type: string ValidationRecords: items: properties: Status: type: string TxtName: type: string TxtValue: type: string type: object type: array Wildcard: type: boolean type: object Status: type: string type: object x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider CustomHostnameCreateOptions: properties: CustomOriginServer: type: string Hostname: type: string SSL: properties: BundleMethod: type: string CertificateAuthority: type: string CustomCertificate: type: string CustomKey: type: string Method: type: string Settings: properties: min_tls_version: type: string x-go-name: MinTLSVersion type: object Type: type: string Wildcard: type: boolean type: object type: object x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 address: description: Ip子网内的地址,不填则按照ip子网的地址分配策略分配一个ip type: string x-go-name: Address auto_renew: default: false description: 是否自动续费(仅包年包月时生效) type: boolean x-go-name: AutoRenew billing_type: $ref: '#/definitions/TBillingType' 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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: prepaid, 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 DiskBackupAsTarInput: properties: container_id: type: string x-go-name: ContainerId exclude_files: items: type: string type: array x-go-name: ExcludeFiles ignore_not_exist_file: type: boolean x-go-name: IgnoreNotExistFile include_files: items: type: string type: array x-go-name: IncludeFiles include_patterns: items: type: string type: array x-go-name: IncludePatterns 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 backup_as_tar: $ref: '#/definitions/DiskBackupAsTarInput' backup_storage_id: description: 'description: backup storage id' type: string x-go-name: BackupStorageId 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_id: type: string x-go-name: BackupStorageId 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 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_config: $ref: '#/definitions/SBackupDiskConfig' disk_id: type: string x-go-name: DiskId disk_name: description: 'description: disk name' type: string x-go-name: DiskName disk_size_mb: format: int64 type: integer x-go-name: DiskSizeMb 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 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_sub_backup: description: 'description: 是否是子备份' type: boolean x-go-name: IsSubBackup 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 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 size_mb: description: 备份大小 format: int64 type: integer x-go-name: SizeMb status: description: 资源状态 type: string x-go-name: Status storage_id: type: string x-go-name: StorageId 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 DiskBackupExportInfo: properties: access_url: type: string x-go-name: AccessUrl disk_config: $ref: '#/definitions/SBackupDiskConfig' disk_size_mb: format: int64 type: integer x-go-name: DiskSizeMb disk_type: type: string x-go-name: DiskType os_arch: type: string x-go-name: OsArch os_type: description: 操作系统类型 type: string x-go-name: OsType size_mb: format: int64 type: integer x-go-name: SizeMb type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute DiskBackupImportInput: properties: access_url: type: string x-go-name: AccessUrl backup_storage_id: type: string x-go-name: BackupStorageId disk_config: $ref: '#/definitions/SBackupDiskConfig' disk_size_mb: format: int64 type: integer x-go-name: DiskSizeMb disk_type: type: string x-go-name: DiskType generate_name: type: string x-go-name: GenerateName name: type: string x-go-name: Name os_arch: type: string x-go-name: OsArch os_type: description: 操作系统类型 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 size_mb: format: int64 type: integer x-go-name: SizeMb type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute DiskBackupRecoveryInput: properties: name: description: 'description: name of disk' type: string x-go-name: Name 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 DiskChagneStorageTypeInput: properties: storage_type: description: 目标存储类型 type: string x-go-name: StorageType type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute DiskChangeBillingTypeInput: properties: billing_type: $ref: '#/definitions/TBillingType' required: - billing_type type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute DiskConfig: properties: auto_delete: description: |- 是否跟随主机删除而自动删除 默认跟随主机创建的磁盘为 true type: boolean x-go-name: AutoDelete auto_reset: description: 关机后自动重置磁盘 type: boolean x-go-name: AutoReset 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 fs_features: $ref: '#/definitions/DiskFsFeatures' 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 auto_delete: description: |- 是否跟随主机删除而自动删除 默认跟随主机创建的磁盘为 true type: boolean x-go-name: AutoDelete auto_reset: description: 关机后自动重置磁盘 type: boolean x-go-name: AutoReset 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 fs_features: $ref: '#/definitions/DiskFsFeatures' 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 - 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 auto_reset: description: auto reset disk after guest shutdown type: boolean x-go-name: AutoReset 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: prepaid, 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 device: description: 设备名称 type: string x-go-name: Device 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_features: $ref: '#/definitions/DiskFsFeatures' fs_format: description: 文件系统 type: string x-go-name: FsFormat guest: description: 所挂载的虚拟机 type: string x-go-name: Guest guest_billing_type: description: 所挂载虚拟机计费类型 type: string x-go-name: GuestBillingType guest_count: description: 所挂载虚拟机的数量 format: int64 type: integer x-go-name: GuestCount guest_snapshotpolicy_count: description: 磁盘所在虚拟机绑定的主机快照策略数量 format: int64 type: integer x-go-name: GuestSnapshotpolicyCount 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 os_arch: description: 操作系统 CPU 架构 example: x86 arm type: string x-go-name: OsArch pci_path: type: string x-go-name: PCIPath 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt snapshot_id: description: 快照Id type: string x-go-name: SnapshotId snapshotpolicies: description: 自动快照策略 items: $ref: '#/definitions/SimpleSnapshotPolicy' type: array x-go-name: Snapshotpolicies 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 DiskFsExt4Features: properties: case_insensitive: type: boolean x-go-name: CaseInsensitive reserved_blocks_percentage: format: int64 type: integer x-go-name: ReservedBlocksPercentage type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute DiskFsF2fsFeatures: properties: case_insensitive: type: boolean x-go-name: CaseInsensitive overprovision_ratio_percentage: format: int64 type: integer x-go-name: OverprovisionRatioPercentage type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute DiskFsFeatures: properties: ext4: $ref: '#/definitions/DiskFsExt4Features' f2fs: $ref: '#/definitions/DiskFsF2fsFeatures' 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: properties: backup_id: type: string x-go-name: BackupId fs: type: string x-go-name: Fs fs_features: $ref: '#/definitions/DiskFsFeatures' size: type: string x-go-name: Size template_id: type: string x-go-name: TemplateId 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 x-go-name: Format name: type: string x-go-name: Name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute DiskSnapshotpolicyInput: properties: snapshotpolicy_id: description: 快照策略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: auto_delete: description: |- 是否跟随主机删除而自动删除 默认跟随主机创建的磁盘为 true type: boolean x-go-name: AutoDelete auto_reset: description: 关机自动重置 type: boolean x-go-name: AutoReset 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 proxied: type: boolean x-go-name: Proxied 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 extra_addresses: description: 目前存储阿里云GTM设置地址及AWS TrafficPolicy端点地址, 仅支持同步 items: type: string type: array x-go-name: ExtraAddresses 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 proxied: description: cloudflare 特有 type: boolean x-go-name: Proxied 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 proxied: type: boolean x-go-name: Proxied 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 name_servers: $ref: '#/definitions/SNameServers' org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 original_name_servers: $ref: '#/definitions/SNameServers' 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 registrar: type: string x-go-name: Registrar 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 auto_renew: default: false description: 是否自动续费(仅包年包月时生效) type: boolean x-go-name: AutoRenew billing_type: $ref: '#/definitions/TBillingType' 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 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 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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_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: prepaid, 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 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: '计费类型: 流量、带宽' example: bandwidth type: string x-go-name: BgpType billing_cycle: description: 计费周期 type: string x-go-name: BillingCycle billing_type: description: 计费类型, 按量、包年包月 example: prepaid, 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt server_private_ip: description: 虚拟机内网IP type: string x-go-name: ServerPrivateIp 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 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: |- swagger: ignore 将在3.12之后版本移除 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_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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: $ref: '#/definitions/TBillingType' 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 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 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 public_scope: description: 共享范围 type: string x-go-name: PublicScope release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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: 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 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 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: type: string x-go-name: Vpc zone: type: string x-go-name: Zone 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 FileSystemSetQuotaInput: properties: MaxFiles: format: int64 type: integer MaxGb: format: int64 type: integer 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 GetDetailsGuestScreenDumpOutput: properties: guest_id: type: string x-go-name: GuestId name: type: string x-go-name: Name screen_dump: type: string x-go-name: ScreenDump 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 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 GuestDiskInfo: properties: aio_mode: type: string x-go-name: AioMode auto_reset: type: boolean x-go-name: AutoReset 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 throughput: format: int64 type: integer x-go-name: Throughput 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 x-go-name: Have 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_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: shell_cmd: type: string x-go-name: ShellCmd type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestMakeSshableInput: properties: password: type: string x-go-name: Password port: format: int64 type: integer x-go-name: Port private_key: type: string x-go-name: PrivateKey user: type: string x-go-name: User type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestMakeSshableOutput: properties: ansible_playbook_id: type: string x-go-name: AnsiblePlaybookId type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestMigrateInput: properties: auto_start: type: boolean x-go-name: AutoStart 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 GuestNetworkAddSecgroupInput: properties: network_index: format: int64 type: integer x-go-name: NetworkIndex secgroup_ids: items: type: string type: array x-go-name: SecgroupIds type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestNetworkTrafficLogDetails: properties: domain_id: description: 域Id type: string x-go-name: DomainId guest_id: type: string x-go-name: GuestId id: format: int64 type: integer x-go-name: Id ip_addr: description: IPv4地址 type: string x-go-name: IpAddr ip6_addr: description: IPv6地址 type: string x-go-name: Ip6Addr mac: description: MAC地址 type: string x-go-name: Mac network_id: type: string x-go-name: NetworkId report_at: format: date-time type: string x-go-name: ReportAt rx_bytes: description: 下行流量，单位 bytes format: int64 type: integer x-go-name: RxBytes state: type: string x-go-name: State tenant_id: description: 项目Id type: string x-go-name: ProjectId tx_bytes: description: 上行流量，单位 bytes format: int64 type: integer x-go-name: TxBytes type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute/guest GuestNetworkTrafficState: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/compute/guest GuestNicTrafficSyncInput: properties: SyncAt: description: 同步时间 format: date-time type: string Traffic: additionalProperties: additionalProperties: $ref: '#/definitions/SNicTrafficRecord' type: object description: |- first key: guest_id second key: nic_mac type: object is_reset: description: 是否重置计数器 type: boolean x-go-name: IsReset type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestPerformStartInput: properties: auto_prepaid: description: 按量机器自动转换为包年包月 type: boolean x-go-name: AutoPrepaid 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 GuestPortMapping: properties: envs: items: $ref: '#/definitions/GuestPortMappingEnv' type: array x-go-name: Envs host_ip: type: string x-go-name: HostIp host_port: format: int64 type: integer x-go-name: HostPort host_port_range: $ref: '#/definitions/GuestPortMappingPortRange' port: description: 容器内部 Port 端口范围 1-65535，-1表示由宿主机自动分配和 HostPort 相同的端口 format: int64 type: integer x-go-name: Port protocol: $ref: '#/definitions/GuestPortMappingProtocol' remote_ips: description: whitelist for remote ips items: type: string type: array x-go-name: RemoteIps rule: $ref: '#/definitions/GuestPortMappingRule' type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestPortMappingEnv: properties: key: type: string x-go-name: Key value_from: $ref: '#/definitions/GuestPortMappingEnvValueFrom' type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestPortMappingEnvValueFrom: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestPortMappingPortRange: 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 GuestPortMappingProtocol: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestPortMappingRule: properties: first_port_offset: format: int64 type: integer x-go-name: FirstPortOffset type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestPortMappings: items: $ref: '#/definitions/GuestPortMapping' type: array 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 GuestRevokeNetworkSecgroupInput: properties: mac_addr: type: string x-go-name: MacAddr network_index: description: 虚机网卡 index 或者 mac 地址 format: int64 type: integer x-go-name: NetworkIndex 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 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 GuestSetNetworkSecgroupInput: properties: mac_addr: type: string x-go-name: MacAddr network_index: description: 虚机网卡 index 或者 mac 地址 format: int64 type: integer x-go-name: NetworkIndex 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 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 x-go-name: Port type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestSshportOutput: properties: port: format: int64 type: integer x-go-name: Port 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: $ref: '#/definitions/TBillingType' 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: $ref: '#/definitions/TBillingType' 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 GuestUpdateSubIpsInput: 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 remove_sub_ips: items: type: string type: array x-go-name: RemoveSubIps 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 GuestUploadContainerStatusResponse: properties: error: type: string x-go-name: Error ok: type: boolean x-go-name: OK type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestUploadStatusResponse: properties: containers: additionalProperties: $ref: '#/definitions/GuestUploadContainerStatusResponse' type: object x-go-name: Containers error: type: string x-go-name: Error ok: type: boolean x-go-name: OK type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestnetworkDetails: properties: billing_type: description: 计费类型, 按量、包年包月 example: prepaid, postpaid type: string x-go-name: BillingType 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 charge_type: description: '计费类型: 流量、带宽' example: bandwidth type: string x-go-name: ChargeType 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_gateway: description: 网关地址 type: string x-go-name: GuestGateway guest_gateway6: description: 网关地址 type: string x-go-name: GuestGateway6 guest_id: type: string x-go-name: GuestId guest_ip_mask: format: int8 type: integer x-go-name: GuestIpMask guest_ip6_mask: format: uint8 type: integer x-go-name: GuestIp6Mask 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 mapped_ip6_addr: description: IPv6映射地址，当子网属于私有云vpc的时候分配，用于访问外网 type: string x-go-name: MappedIp6Addr 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 port_mappings: description: 端口映射 items: $ref: '#/definitions/GuestPortMapping' type: array x-go-name: PortMappings 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 GuestnetworkSecgroupShortDesc: properties: mac: type: string x-go-name: Mac network_index: format: int64 type: integer x-go-name: NetworkIndex secgroups: items: $ref: '#/definitions/StandaloneShortDesc' type: array x-go-name: Secgroups type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute GuestnetworkShortDesc: properties: bgp_type: description: 线路类型 type: string x-go-name: BgpType billing_type: $ref: '#/definitions/TBillingType' bw_limit_mbps: description: Bandwidth format: int64 type: integer x-go-name: BwLimitMbps charge_type: $ref: '#/definitions/TNetChargeType' guest_id: description: 所属主机 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: IP地址 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 is_exit: description: 是否为外网网卡 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 nic_type: description: |- 网卡类型 可能值：exit | internal | unused type: string x-go-name: NicType port_mappings: $ref: '#/definitions/GuestPortMappings' 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 GuestnetworksecgroupDetails: 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: type: boolean x-go-name: Admin brand: description: 云平台品牌 example: Google type: string x-go-name: Brand 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 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 guest: description: 虚拟机名称 type: string x-go-name: Guest guest_id: type: string x-go-name: GuestId guest_network: type: string x-go-name: GuestNetwork guest_status: description: 虚拟机状态 type: string x-go-name: GuestStatus host: description: 宿主机名称 type: string x-go-name: Host host_access_ip: description: 宿主机管理IP type: string x-go-name: HostAccessIp host_access_mac: description: 宿主机MAC type: string x-go-name: HostAccessMac host_billing_type: $ref: '#/definitions/TBillingType' host_eip: description: 宿主机公网IP（如果有） type: string x-go-name: HostEIP host_enabled: description: 宿主是否启用 type: boolean x-go-name: HostEnabled host_id: description: 宿主机ID type: string x-go-name: HostId host_resource_type: type: string x-go-name: HostResourceType 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 ifname: type: string x-go-name: Ifname ip_6_addr: type: string x-go-name: Ip6Addr ip_addr: type: string x-go-name: IpAddr mac_addr: 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: 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_id: type: string x-go-name: NetworkId network_index: format: int64 type: integer x-go-name: NetworkIndex network_name: type: string x-go-name: NetworkName 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 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 secgroup_status: description: 安全组状态 type: string x-go-name: SecgroupStatus tenant: description: |- 资源归属项目的名称 alias:project type: string x-go-name: Project tenant_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 vpc: type: string x-go-name: Vpc 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 HTTPHeader: description: HTTPHeader describes a custom header to be used in HTTP probes properties: name: description: The header field name type: string x-go-name: Name value: description: The header field value type: string x-go-name: Value type: object x-go-package: yunion.io/x/onecloud/pkg/apis 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 ip6_addr: type: string x-go-name: Ip6Addr 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 require_ipv6: type: boolean x-go-name: RequireIpv6 reserve: type: boolean x-go-name: Reserve reset: type: boolean x-go-name: Reset strict_ipv6: type: boolean x-go-name: StrictIpv6 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 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: uint8 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 kvm_cap_max_vcpu: description: KVM 允许单台虚机最大 vcpu 个数 format: int64 type: integer x-go-name: KvmCapMaxVcpu 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_ip: description: 公网IP type: string x-go-name: PublicIp 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: 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: prepaid, 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 cpu_usage_percent: format: double type: number x-go-name: CpuUsagePercent 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: description: scheduler cpu-node/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 guest_pinned_cpus: items: format: int64 type: integer type: array x-go-name: GuestPinnedCpus guests: description: 云主机数量 example: 10 format: int64 type: integer x-go-name: Guests host_files: items: type: string type: array x-go-name: HostFiles 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 isolated_device_count: description: isolated device count format: int64 type: integer x-go-name: IsolatedDeviceCount isolated_device_type_count: additionalProperties: format: int64 type: integer type: object x-go-name: IsolatedDeviceTypeCount kvm_cap_max_vcpu: description: KVM CAP VCPU MAX format: int64 type: integer x-go-name: KvmCapMaxVcpu 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 memory_used_mb: format: int64 type: integer x-go-name: MemoryUsedMb 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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_mapped_ip6_addr: description: IPv6地址，作为私有云vpc访问外网时的网关 type: string x-go-name: OvnMappedIp6Addr 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_ip: description: 公网Ip地址 type: string x-go-name: PublicIp 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt reserved_resource_for_gpu: $ref: '#/definitions/IsolatedDeviceReservedResourceInput' resource_type: type: string x-go-name: ResourceType root_partition_used_capacity_mb: format: int64 type: integer x-go-name: RootPartitionUsedCapacityMb 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 ip6_addr: type: string x-go-name: Ip6Addr mac: type: string x-go-name: Mac net_type: $ref: '#/definitions/TNetworkType' network_id: type: string x-go-name: NetworkId require_designated_ip: type: boolean x-go-name: RequireDesignatedIp require_ipv6: type: boolean x-go-name: RequireIpv6 reserve: type: boolean x-go-name: Reserve strict_ipv6: type: boolean x-go-name: StrictIpv6 vlan_id: format: int64 type: integer x-go-name: VlanId type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute HostFileCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata content: 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 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 path: type: string x-go-name: Path project_domain_id: description: 指定项目归属域名称或ID type: string x-go-name: ProjectDomainId public_scope: description: 共享范围 type: string x-go-name: PublicScope type: $ref: '#/definitions/HostFileType' required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute HostFileDetails: 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: 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 domain_id: description: 域Id type: string x-go-name: DomainId domain_src: description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' example: local type: string x-go-name: DomainSrc hosts: items: type: string type: array x-go-name: Hosts 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 path: type: string x-go-name: Path 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 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 HostFileType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/compute HostInfo: properties: access_ip: description: 宿主机管理IP type: string x-go-name: AccessIp access_mac: description: 宿主机MAC type: string x-go-name: AccessMac billing_type: description: 宿主机计费类型 type: string x-go-name: BillingType enabled: description: 宿主是否启用 type: boolean x-go-name: Enabled host_status: description: 宿主机服务状态` type: string x-go-name: HostStatus host_type: description: 宿主机类型 type: string x-go-name: HostType id: description: 宿主机ID type: string x-go-name: Id name: description: 宿主机名称 type: string x-go-name: Name public_ip: description: 宿主机公网IP（如果有） type: string x-go-name: PublicIp resource_type: type: string x-go-name: ResourceType sn: description: 宿主机序列号 type: string x-go-name: SN status: description: 宿主机状态 type: string x-go-name: Status 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 HostLowerPath: properties: post_path: type: string x-go-name: PostPath pre_path: type: string x-go-name: PrePath type: object x-go-package: yunion.io/x/onecloud/pkg/apis HostOfflineInput: properties: reason: type: string x-go-name: Reason 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 x-go-name: Cpus disable_sched_load_balance: type: boolean x-go-name: DisableSchedLoadBalance mems: type: string x-go-name: Mems processes_prefix: items: type: string type: array x-go-name: ProcessesPrefix type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute HostSetCommitBoundInput: properties: CpuCmtbound: format: float type: number MemCmtbound: format: float type: number type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute HostSetHostFilesInput: properties: host_files: items: type: string type: array x-go-name: HostFiles 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: uint8 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 kvm_cap_max_vcpu: description: KVM 允许单台虚机最大 vcpu 个数 format: int64 type: integer x-go-name: KvmCapMaxVcpu 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 public_ip: description: 公网IP type: string x-go-name: PublicIp 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 HostUploadGuestStatusInput: properties: containers: additionalProperties: $ref: '#/definitions/ContainerPerformStatusInput' type: object x-go-name: Containers 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/compute HostnetworkTopologyOutput: properties: ip_addr: type: string x-go-name: IpAddr ip6_addr: type: string x-go-name: Ip6Addr mac_addr: type: string x-go-name: MacAddr 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_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-package: yunion.io/x/onecloud/pkg/apis InfrasResourceBaseUpdateInput: 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 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 backup_storage_id: type: string x-go-name: BackupStorageId 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 package_name: type: string x-go-name: PackageName 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: package_name: type: string x-go-name: PackageName type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute InstanceBackupRecoveryInput: properties: name: description: 'description: name of guest' type: string x-go-name: Name 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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_kb: description: 内存文件大小 format: int64 type: integer x-go-name: MemorySizeKB metadata: additionalProperties: type: string description: 标签 type: object x-go-name: Metadata name: description: 资源名称 type: string x-go-name: Name org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: 主机快照大小, B format: int64 type: integer x-go-name: Size size_mb: description: 主机快照大小, MiB 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 virtual_size_mb: description: 主机磁盘大小, MiB format: int64 type: integer x-go-name: VirtualSizeMb 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: vpc_id: type: string x-go-name: VpcId 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 card_path: description: GPU card path, like /dev/dri/cardX type: string x-go-name: CardPath 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_minor: description: Nvidia GPU minor number, parsing from /proc/driver/nvidia/gpus/*/information format: int64 type: integer x-go-name: DeviceMinor 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 external_id: description: 云上Id, 对应云上资源自身Id type: string x-go-name: ExternalId 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_access_ip: description: 宿主机管理IP type: string x-go-name: HostAccessIp host_access_mac: description: 宿主机MAC type: string x-go-name: HostAccessMac host_billing_type: $ref: '#/definitions/TBillingType' host_eip: description: 宿主机公网IP（如果有） type: string x-go-name: HostEIP host_enabled: description: 宿主是否启用 type: boolean x-go-name: HostEnabled host_id: type: string x-go-name: HostId host_resource_type: type: string x-go-name: HostResourceType 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 imported_at: description: 资源导入时间 format: date-time type: string x-go-name: ImportedAt index: description: Nvidia GPU index format: int64 type: integer x-go-name: Index 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 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 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 mps_memory_limit: description: MPS perdevice memory limit MB format: int64 type: integer x-go-name: MpsMemoryLimit mps_memory_total: description: MPS device memory total MB format: int64 type: integer x-go-name: MpsMemoryTotal mps_thread_percentage: description: MPS device thread percentage format: int64 type: integer x-go-name: MpsThreadPercentage 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 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 render_path: description: GPU render path, like /dev/dri/renderDX type: string x-go-name: RenderPath 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 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 update_fail_reason: $ref: '#/definitions/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_minor: format: int64 type: integer x-go-name: DeviceMinor device_path: description: Host device path type: string x-go-name: DevicePath index: format: int64 type: integer x-go-name: Index 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: prepaid, 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 owner_id: description: 本地用户Id type: string x-go-name: OwnerId owner_name: description: 用户名称 type: string x-go-name: OwnerName 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 KickstartConfig: description: KickstartConfig Kickstart/Autoinstall自动化安装配置 properties: config: description: 配置文件内容 (当用户直接提供配置时使用) type: string x-go-name: Config config_url: description: 配置文件 URL (当配置文件位于外部服务器时使用) type: string x-go-name: ConfigURL enabled: default: true description: 是否启用 (用于临时禁用而不删除配置) type: boolean x-go-name: Enabled max_retries: default: 3 description: 最大重试次数 format: int64 type: integer x-go-name: MaxRetries os_type: description: 操作系统类型 (用于确定内核参数和文件路径) enum: - centos - rhel - fedora - openeuler - ubuntu type: string x-go-name: OSType timeout_minutes: default: 60 description: 安装超时时间 (分钟) format: int64 type: integer x-go-name: TimeoutMinutes required: - os_type 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' org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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: can_delete: description: 资源是否可以删除, 若为flase, delete_fail_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' domain_id: type: string x-go-name: DomainId 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' 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: can_delete: description: 资源是否可以删除, 若为flase, delete_fail_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' domain_id: type: string x-go-name: DomainId 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 LbEip: properties: 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 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 ListenerRuleBackendGroup: properties: id: description: 后端服务器组组ID type: string x-go-name: Id type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ListenerRuleBackendGroups: items: $ref: '#/definitions/ListenerRuleBackendGroup' type: array x-go-package: yunion.io/x/onecloud/pkg/apis/compute ListenerRuleRedirectPool: properties: country_pools: additionalProperties: $ref: '#/definitions/ListenerRuleBackendGroups' type: object x-go-name: CountryPools region_pools: additionalProperties: $ref: '#/definitions/ListenerRuleBackendGroups' type: object x-go-name: RegionPools 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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: deploy_method: type: string x-go-name: DeployMethod 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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_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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 x-go-name: Address backend_role: type: string x-go-name: BackendRole backend_type: type: string x-go-name: BackendType external_id: type: string x-go-name: ExternalId host_name: type: string x-go-name: HostName id: type: string x-go-name: Id index: format: int64 type: integer x-go-name: Index name: type: string x-go-name: Name port: format: int64 type: integer x-go-name: Port weight: format: int64 type: integer x-go-name: Weight zone_id: type: string x-go-name: ZoneId 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_health_check_id: type: string x-go-name: LoadbalancerHealthCheckId 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 scheduler: type: string x-go-name: Scheduler 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_health_check: type: string x-go-name: LoadbalancerHealthCheck loadbalancer_health_check_id: type: string x-go-name: LoadbalancerHealthCheckId 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 scheduler: type: string x-go-name: Scheduler 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 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 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_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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: can_delete: description: 资源是否可以删除, 若为flase, delete_fail_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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 params: $ref: '#/definitions/SLoadbalancerClusterParams' ref_counts: additionalProperties: format: int64 type: integer type: object x-go-name: RefCounts 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: $ref: '#/definitions/TNetChargeType' 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 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_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: $ref: '#/definitions/TNetChargeType' 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_count: format: int64 type: integer x-go-name: BackendGroupCount backend_group_id: description: 默认后端服务器组Id type: string x-go-name: BackendGroupId billing_cycle: description: 计费周期 type: string x-go-name: BillingCycle billing_type: description: 计费类型, 按量、包年包月 example: prepaid, 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 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 eips: items: $ref: '#/definitions/LbEip' type: array x-go-name: Eips 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 listener_count: format: int64 type: integer x-go-name: ListenerCount 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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 LoadbalancerHealthCheckDetails: 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 LoadbalancerListenerCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata 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_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_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_domain: type: string x-go-name: HealthCheckDomain 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_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 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: description: 连接请求超时时间 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: Gzip数据压缩 type: boolean x-go-name: Gzip health_check: description: 健康检查开启状态 on|off type: string x-go-name: HealthCheck health_check_domain: description: 健康检查域名 yunion.cn type: string x-go-name: HealthCheckDomain health_check_exp: description: UDP监听健康检查的响应串 type: string x-go-name: HealthCheckExp health_check_fall: description: 健康检查不健康阈值 15秒 format: int64 type: integer x-go-name: HealthCheckFall health_check_http_code: description: HTTP正常状态码 http_2xx,http_3xx type: string x-go-name: HealthCheckHttpCode health_check_interval: description: 健康检查间隔时间 5秒 format: int64 type: integer x-go-name: HealthCheckInterval health_check_method: description: 健康检查方法 GET|POST|HEAD type: string x-go-name: HealthCheckMethod health_check_port: description: 健康检查端口 80 format: int64 type: integer x-go-name: HealthCheckPort health_check_req: description: UDP监听健康检查的请求串 type: string x-go-name: HealthCheckReq health_check_rise: description: 健康检查健康阈值 3秒 format: int64 type: integer x-go-name: HealthCheckRise health_check_timeout: description: 健康检查超时时间 10秒 format: int64 type: integer x-go-name: HealthCheckTimeout health_check_type: description: 健康检查协议 HTTP|TCP type: string x-go-name: HealthCheckType health_check_uri: description: 健康检查路径 / type: string x-go-name: HealthCheckURI http_request_rate: description: 限定监听接收请示速率 format: int64 type: integer x-go-name: HTTPRequestRate http_request_rate_per_src: description: 源IP监听请求最大速率 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress provider: description: 云平台名称 example: Google type: string x-go-name: Provider redirect: description: 跳转类型 type: string x-go-name: Redirect redirect_code: description: 跳转HTTP code format: int64 type: integer x-go-name: RedirectCode redirect_host: description: 跳转时变更Host type: string x-go-name: RedirectHost redirect_path: description: 跳转时变更Path type: string x-go-name: RedirectPath redirect_scheme: description: 跳转uri scheme 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: description: 会话保持开启状态 on|off type: string x-go-name: StickySession sticky_session_cookie: description: Cookie名称 type: string x-go-name: StickySessionCookie sticky_session_cookie_timeout: description: 会话超时时间 format: int64 type: integer x-go-name: StickySessionCookieTimeout sticky_session_type: description: Cookie处理方式 insert(植入cookie)|server(重写cookie) 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: description: 获取客户端真实IP 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 backend_group_id: description: 默认后端服务器组ID type: string x-go-name: BackendGroupId backend_groups: $ref: '#/definitions/ListenerRuleBackendGroups' certificate_id: type: string x-go-name: CertificateId 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_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 redirect: 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_pool: $ref: '#/definitions/ListenerRuleRedirectPool' redirect_scheme: type: string x-go-name: RedirectScheme 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: description: 默认后端服务器组 type: string x-go-name: BackendGroupId backend_groups: $ref: '#/definitions/ListenerRuleBackendGroups' 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 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: description: 域名 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: description: 健康检查开启状态 on|off type: string x-go-name: HealthCheck health_check_domain: description: 健康检查域名 yunion.cn type: string x-go-name: HealthCheckDomain health_check_exp: description: UDP监听健康检查的响应串 type: string x-go-name: HealthCheckExp health_check_fall: description: 健康检查不健康阈值 15秒 format: int64 type: integer x-go-name: HealthCheckFall health_check_http_code: description: HTTP正常状态码 http_2xx,http_3xx type: string x-go-name: HealthCheckHttpCode health_check_interval: description: 健康检查间隔时间 5秒 format: int64 type: integer x-go-name: HealthCheckInterval health_check_method: description: 健康检查方法 GET|POST|HEAD type: string x-go-name: HealthCheckMethod health_check_port: description: 健康检查端口 80 format: int64 type: integer x-go-name: HealthCheckPort health_check_req: description: UDP监听健康检查的请求串 type: string x-go-name: HealthCheckReq health_check_rise: description: 健康检查健康阈值 3秒 format: int64 type: integer x-go-name: HealthCheckRise health_check_timeout: description: 健康检查超时时间 10秒 format: int64 type: integer x-go-name: HealthCheckTimeout health_check_type: description: 健康检查协议 HTTP|TCP type: string x-go-name: HealthCheckType health_check_uri: description: 健康检查路径 / type: string x-go-name: HealthCheckURI http_request_rate: description: 限定监听接收请示速率 format: int64 type: integer x-go-name: HTTPRequestRate http_request_rate_per_src: description: 源IP监听请求最大速率 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: description: 跳转类型 type: string x-go-name: Redirect redirect_code: description: 跳转HTTP code format: int64 type: integer x-go-name: RedirectCode redirect_host: description: 跳转时变更Host type: string x-go-name: RedirectHost redirect_path: description: 跳转时变更Path type: string x-go-name: RedirectPath redirect_pool: $ref: '#/definitions/ListenerRuleRedirectPool' redirect_scheme: description: 跳转uri scheme 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: 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_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 redirect: 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 type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute LoadbalancerListenerUpdateInput: properties: 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_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: node_count: format: int64 type: integer x-go-name: NodeCount 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: prepaid, 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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: prepaid, 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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: 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 file_system: type: string x-go-name: FileSystem 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: $ref: '#/definitions/TBillingType' 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: $ref: '#/definitions/TNetChargeType' 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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: prepaid, 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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 description: description: 资源描述 example: test create network type: string x-go-name: Description dry_run: default: false description: 预检验参数,若为true则仅检查参数,并不真正创建变更 type: boolean x-go-name: DryRun guest_id: type: string x-go-name: GuestId guestnetwork_index: format: int8 type: integer x-go-name: GuestnetworkIndex 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 network_id: type: string x-go-name: NetworkId parent_id: format: int64 type: integer x-go-name: ParentId parent_type: $ref: '#/definitions/TNetworkAddressParentType' type: type: string x-go-name: Type type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute NetworkAddressDetails: 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 guestnetwork: $ref: '#/definitions/GuestnetworkDetails' ip_addr: type: string x-go-name: IpAddr 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 network_id: type: string x-go-name: NetworkId parent_id: type: string x-go-name: ParentId parent_type: type: string x-go-name: ParentType 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 sub_ctr_vid: format: int64 type: integer x-go-name: SubCtrVid type: type: string x-go-name: Type 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 billing_type: $ref: '#/definitions/TBillingType' bw_limit: format: int64 type: integer x-go-name: BwLimit charge_type: $ref: '#/definitions/TNetChargeType' 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: $ref: '#/definitions/TNetworkType' network: description: 子网名称或ID type: string x-go-name: Network num_queues: format: int64 type: integer x-go-name: NumQueues port_mappings: $ref: '#/definitions/GuestPortMappings' 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 secgroups: description: network secgroups items: type: string type: array x-go-name: Secgroups 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 strict_ipv6: description: 只分配IPv6地址，禁用IPv4 type: boolean x-go-name: StrictIPv6 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: $ref: '#/definitions/TNetworkType' status: description: 用来存储资源的状态 type: string x-go-name: Status 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_domain: description: search domain type: string x-go-name: GuestDomain 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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: $ref: '#/definitions/TNetworkType' 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: $ref: '#/definitions/TNetworkType' 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 server_type: $ref: '#/definitions/TNetworkType' vlan_id: format: int64 type: integer x-go-name: VlanId type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute OpsLogCreateInput: properties: action: type: string x-go-name: Action domain: type: string x-go-name: Domain domain_id: type: string x-go-name: DomainId notes: type: string x-go-name: Notes obj_id: type: string x-go-name: ObjId obj_name: type: string x-go-name: ObjName obj_type: type: string x-go-name: ObjType owner_domain_id: type: string x-go-name: OwnerDomainId owner_tenant_id: type: string x-go-name: OwnerProjectId project_domain: type: string x-go-name: ProjectDomain project_domain_id: type: string x-go-name: ProjectDomainId roles: type: string x-go-name: Roles tenant: type: string x-go-name: Project tenant_id: type: string x-go-name: ProjectId 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 OpsLogDetails: 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 delete_fail_reason: $ref: '#/definitions/Error' domain: type: string x-go-name: Domain domain_id: type: string x-go-name: DomainId id: format: int64 type: integer x-go-name: Id notes: type: string x-go-name: Notes obj_id: type: string x-go-name: ObjId obj_name: type: string x-go-name: ObjName obj_type: type: string x-go-name: ObjType ops_time: format: date-time type: string x-go-name: OpsTime owner_domain: type: string x-go-name: OwnerDomain owner_domain_id: type: string x-go-name: OwnerDomainId owner_project_id: type: string x-go-name: OwnerProjectId owner_tenant: type: string x-go-name: OwnerProject project_domain: type: string x-go-name: ProjectDomain project_domain_id: type: string x-go-name: ProjectDomainId roles: type: string x-go-name: Roles tenant: type: string x-go-name: Project tenant_id: type: string x-go-name: ProjectId 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 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 PodContainerCreateInput: properties: always_restart: type: boolean x-go-name: AlwaysRestart 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 cgroup_pids_max: format: int64 type: integer x-go-name: CgroupPidsMax command: description: Command to execute (i.e., entrypoint for docker) items: type: string type: array x-go-name: Command depends_on: description: |- DependsOn is a list of container name which this container depends on when pod start Only works for containers created & started by pod-create & server-start items: type: string type: array x-go-name: DependsOn devices: items: $ref: '#/definitions/ContainerDevice' type: array x-go-name: Devices disable_no_new_privs: type: boolean x-go-name: DisableNoNewPrivs 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_credential_id: description: Image credential id type: string x-go-name: ImageCredentialId image_pull_policy: $ref: '#/definitions/ImagePullPolicy' lifecyle: $ref: '#/definitions/ContainerLifecyle' name: description: Container name type: string x-go-name: Name primary: type: boolean x-go-name: Primary privileged: type: boolean x-go-name: Privileged resources_limit: $ref: '#/definitions/ContainerResources' rootfs: $ref: '#/definitions/ContainerRootfs' security_context: $ref: '#/definitions/ContainerSecurityContext' shm_size_mb: format: int64 type: integer x-go-name: ShmSizeMB simulate_cpu: type: boolean x-go-name: SimulateCpu startup_probe: $ref: '#/definitions/ContainerProbe' 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 PodContainerDesc: properties: id: type: string x-go-name: Id image: type: string x-go-name: Image name: type: string x-go-name: Name status: type: string x-go-name: Status 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 host_ipc: type: boolean x-go-name: HostIPC security_context: $ref: '#/definitions/PodSecurityContext' type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute PodSecurityContext: properties: run_as_group: format: int64 type: integer x-go-name: RunAsGroup run_as_user: format: int64 type: integer x-go-name: RunAsUser type: object 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: can_delete: description: 资源是否可以删除, 若为flase, delete_fail_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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 policydefinition: type: string x-go-name: Policydefinition 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 PostOverlayUpperConfig: properties: disk: $ref: '#/definitions/PostOverlayUpperConfigDisk' type: $ref: '#/definitions/PostOverlayUpperConfigType' type: object x-go-package: yunion.io/x/onecloud/pkg/apis PostOverlayUpperConfigDisk: properties: sub_path: type: string x-go-name: SubPath type: object x-go-package: yunion.io/x/onecloud/pkg/apis PostOverlayUpperConfigType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis PostpaidExpireInput: properties: duration: type: string x-go-name: Duration release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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: 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain 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' items: $ref: '#/definitions/ProjectMappingRuleInfoDetails' type: array 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: 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 domain: type: string x-go-name: Domain project: type: string x-go-name: Project project_id: description: 符合条件时，资源放置的项目id, 此参数和auto_create_project互斥 type: string x-go-name: ProjectId tags: $ref: '#/definitions/TTagSet' tenant: type: string x-go-name: Tenant tenant_id: type: string x-go-name: TenantId 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 RedfishSystemInfo: properties: info: x-go-name: Info path: type: string x-go-name: Path type: object x-go-package: yunion.io/x/onecloud/pkg/apis/baremetal 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 RootDiskMatcherSizeMBRange: 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 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: accociation_count: format: int64 type: integer x-go-name: AccociationCount 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 route_set_count: format: int64 type: integer x-go-name: RouteSetCount 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 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 route_table_id: type: string x-go-name: RouteTableId 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 x-go-name: Permissions 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 x-go-name: Cidr comment: type: string x-go-name: Comment type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute SBackupDiskConfig: properties: auto_delete: description: |- 是否跟随主机删除而自动删除 默认跟随主机创建的磁盘为 true type: boolean x-go-name: AutoDelete auto_reset: description: 关机后自动重置磁盘 type: boolean x-go-name: AutoReset 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_as_tar: $ref: '#/definitions/DiskBackupAsTarInput' 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 fs_features: $ref: '#/definitions/DiskFsFeatures' 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 name: type: string 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 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 title: SBackupDiskConfig is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SBackupDiskConfig. 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: Total: format: int64 type: integer data: items: $ref: '#/definitions/SCloudResource' type: array x-go-name: Data 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 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 RegionId: 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 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: disk_size_gb: format: int64 type: integer x-go-name: DiskSizeGB instance_type: type: string x-go-name: InstanceType 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: $ref: '#/definitions/TNetChargeType' 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: prepaid, postpaid type: string x-go-name: BillingType bios: type: string x-go-name: Bios boot_order: description: 启动顺序 type: string x-go-name: BootOrder cpu_numa_pin: description: CPU 内存绑定信息 type: object x-go-name: CpuNumaPin 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 extra_cpu_count: description: 额外分配的 CPU 数量 format: int64 type: integer x-go-name: ExtraCpuCount flavor_id: type: string x-go-name: FlavorId freezed: description: 资源是否被冻结 type: boolean x-go-name: Freezed health_status: description: 健康状态, 仅开机中火运行中有效， 目前只支持阿里云 type: string x-go-name: HealthStatus 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 last_start_at: description: 上次开机时间 format: date-time type: string x-go-name: LastStartAt machine: type: string x-go-name: Machine name: description: 资源名称 type: string x-go-name: Name org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt rescue_mode: description: Used for guest rescue type: boolean x-go-name: RescueMode resource_pool: description: 资源池,仅vmware指定调度标签时内部使用 type: string x-go-name: ResourcePool 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: cpu_usage_percent: format: double type: number x-go-name: CpuUsagePercent memory_used_mb: format: int64 type: integer x-go-name: MemoryUsedMb qga_running_guests: items: type: string type: array x-go-name: QgaRunningGuestIds 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 SHostReportDmesgInput: properties: entries: items: $ref: '#/definitions/SKmsgEntry' type: array x-go-name: Entries 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 card_path: description: GPU card path, like /dev/dri/cardX type: string x-go-name: CardPath 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_minor: description: Nvidia GPU minor number, parsing from /proc/driver/nvidia/gpus/*/information format: int64 type: integer x-go-name: DeviceMinor device_path: type: string x-go-name: DevicePath disk_index: description: guest disk index format: uint8 type: integer x-go-name: DiskIndex external_id: description: 云上Id, 对应云上资源自身Id type: string x-go-name: ExternalId 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 imported_at: description: 资源导入时间 format: date-time type: string x-go-name: ImportedAt index: description: Nvidia GPU index format: int64 type: integer x-go-name: Index 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 is_public: description: 是否共享 type: boolean x-go-name: IsPublic 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 mps_memory_limit: description: MPS perdevice memory limit MB format: int64 type: integer x-go-name: MpsMemoryLimit mps_memory_total: description: MPS device memory total MB format: int64 type: integer x-go-name: MpsMemoryTotal mps_thread_percentage: description: MPS device thread percentage format: int64 type: integer x-go-name: MpsThreadPercentage 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 ovs_offload_interface: description: Offload interface name type: string x-go-name: OvsOffloadInterface pcie_info: $ref: '#/definitions/IsolatedDevicePCIEInfo' public_scope: description: 默认共享范围 type: string x-go-name: PublicScope public_src: description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' example: local type: string x-go-name: PublicSrc render_path: description: GPU render path, like /dev/dri/renderDX type: string x-go-name: RenderPath 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 source: description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' type: string x-go-name: Source 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 SKmsgEntry: properties: level: format: int64 type: integer x-go-name: Level message: type: string x-go-name: Message sql: format: int64 type: integer x-go-name: Seq time: format: date-time type: string x-go-name: Time type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute 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 SLoadbalancerHealthCheckCreateInput: 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 health_check_domain: type: string x-go-name: HealthCheckDomain health_check_exp: type: string x-go-name: HealthCheckExp health_check_fall: format: int64 type: integer x-go-name: HealthCheckFall health_check_http_code: type: string x-go-name: HealthCheckHttpCode health_check_interval: format: int64 type: integer x-go-name: HealthCheckInterval health_check_method: type: string x-go-name: HealthCheckMethod health_check_port: format: int64 type: integer x-go-name: HealthCheckPort health_check_req: type: string x-go-name: HealthCheckReq health_check_rise: format: int64 type: integer x-go-name: HealthCheckRise health_check_timeout: format: int64 type: integer x-go-name: HealthCheckTimeout health_check_type: type: string x-go-name: HealthCheckType health_check_uri: type: string x-go-name: HealthCheckURI 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 SLoadbalancerHealthCheckUpdateInput: 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 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 SNameServers: items: type: string type: array x-go-package: yunion.io/x/onecloud/pkg/apis/compute SNatDCreateInput: properties: eip: type: string x-go-name: Eip external_ip: type: string x-go-name: ExternalIp external_port: format: int64 type: integer x-go-name: ExternalPort internal_ip: type: string x-go-name: InternalIp internal_port: format: int64 type: integer x-go-name: InternalPort ip_protocol: type: string x-go-name: IpProtocol name: type: string x-go-name: Name natgateway_id: type: string x-go-name: NatgatewayId type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute SNatSCreateInput: properties: eip: type: string x-go-name: Eip name: type: string x-go-name: Name natgateway_id: type: string x-go-name: NatgatewayId network_id: type: string x-go-name: NetworkId source_cidr: type: string x-go-name: SourceCidr type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute SNetworkUsedAddress: properties: associate_id: type: string x-go-name: AssociateId associate_type: type: string x-go-name: AssociateType created_at: format: date-time type: string x-go-name: CreatedAt ip_addr: type: string x-go-name: IpAddr ip6_addr: type: string x-go-name: Ip6Addr mac_addr: type: string x-go-name: MacAddr owner: type: string x-go-name: Owner owner_id: type: string x-go-name: OwnerId owner_status: type: string x-go-name: OwnerStatus owner_type: type: string x-go-name: OwnerType 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 is_default: type: boolean x-go-name: IsDefault 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 SNicTrafficRecord: properties: has_been_set_down: type: boolean x-go-name: HasBeenSetDown rx_traffic: format: int64 type: integer x-go-name: RxTraffic tx_traffic: format: int64 type: integer x-go-name: TxTraffic 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata certificate: type: string x-go-name: Certificate city: type: string x-go-name: City common: type: string x-go-name: Common country: type: string x-go-name: Country description: description: 资源描述 example: test create network type: string x-go-name: Description dns_zone_id: type: string x-go-name: DnsZoneId 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 issuer: type: string x-go-name: Issuer 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 org_name: type: string x-go-name: OrgName 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 province: type: string x-go-name: Province sans: type: string x-go-name: Sans status: description: 用来存储资源的状态 type: string x-go-name: Status required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute SSLCertificateDetails: 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_expired: description: 是否过期 type: boolean x-go-name: IsExpired 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 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 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 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 x-go-name: Wire wire_id: type: string x-go-name: WireId 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: description: |- 创建自动快照策略的执行周期 1. 周一到周日 2. 1~7, 1: Monday, 7: Sunday items: format: int64 type: integer type: array x-go-name: RepeatWeekdays retention_count: description: |- 自动快照保留数量 此配置优先级高于 RetentionDays format: int64 type: integer x-go-name: RetentionCount retention_days: description: '自动快照保留时长 -1: 表示永久保留' format: int64 type: integer x-go-name: RetentionDays status: description: 用来存储资源的状态 type: string x-go-name: Status time_points: description: |- 创建自动快照策略的执行时间 0:00~23:59 每天, 0~23 每小时 创建自动快照策略的时间必须与 RepeatWeekdays 对应的创建周期相一致 items: format: int64 type: integer type: array x-go-name: TimePoints type: description: |- 快照类型, 目前支持 disk, server disk: 自动磁盘快照策略， 只能关联磁盘 server: 自动主机快照策略, 只能关联主机 type: string x-go-name: Type required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute SSnapshotPolicyUpdateInput: properties: RetentionCount: description: |- 自动快照保留数量 此配置优先级高于 RetentionDays format: int64 type: integer RetentionDays: description: '自动快照保留时长, -1: 表示永久保留' 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: description: |- 自动快照执行周期 1. 周一到周日 2. 1~7, 1: Monday, 7: Sunday items: format: int64 type: integer type: array x-go-name: RepeatWeekdays time_points: description: |- 自动快照执行时间 0:00~23:59 每天, 0~23 每小时 创建自动快照策略的时间必须与 RepeatWeekdays 对应的创建周期相一致 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 STagFilters: properties: Filters: items: additionalProperties: items: type: string type: array type: object type: array NoFilters: items: additionalProperties: items: type: string type: array type: object type: array type: object x-go-package: yunion.io/x/onecloud/pkg/util/tagutils STapServiceConfig: properties: ifname: type: string x-go-name: Ifname mac_addr: type: string x-go-name: MacAddr mirrors: items: $ref: '#/definitions/SMirrorConfig' type: array x-go-name: Mirrors 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' config: description: 规则配置 type: object x-go-name: Config 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 enabled: description: 资源是否启用 type: boolean x-go-name: Enabled expression: description: 条件表达式 type: string x-go-name: Expression 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 type: description: 规则类型 type: string x-go-name: Type 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 cloudregion: description: 'description: cloud region id or name' example: cr-test-one type: string x-go-name: Cloudregion 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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: 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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 guest_nic_cnt: description: 关联云主机网卡数量, 不包含回收站云主机 format: int64 type: integer x-go-name: GuestNicCnt 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: 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 action: type: string x-go-name: Action 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: type: string x-go-name: CIDR 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: type: string x-go-name: Description direction: type: string x-go-name: Direction environment: description: Environment type: string x-go-name: Environment 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 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 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 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: 安全组名称 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 x-go-name: Description name: type: string x-go-name: Name 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 no_sync: type: boolean x-go-name: NoSync type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ServerChangeBillingTypeInput: properties: billing_type: $ref: '#/definitions/TBillingType' required: - billing_type type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ServerChangeConfigInput: properties: 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 extra_cpu_count: description: 任务分配CPU大小 format: int64 type: integer x-go-name: ExtraCpuCount instance_type: description: |- 关机且停机不收费情况下不允许调整配置 实例类型, 优先级高于vcpu_count和vmem_size type: string x-go-name: InstanceType reset_traffic_limits: items: $ref: '#/definitions/ServerNicTrafficLimit' type: array x-go-name: ResetTrafficLimits set_traffic_limits: items: $ref: '#/definitions/ServerNicTrafficLimit' type: array x-go-name: SetTrafficLimits 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: $ref: '#/definitions/TNetChargeType' 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 baremetal_root_disk_matcher: $ref: '#/definitions/BaremetalRootDiskMatcher' 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: $ref: '#/definitions/TNetChargeType' enable_cloud_init: default: false description: 启用cloud-init,需要镜像装有cloud-init服务 type: boolean x-go-name: EnableCloudInit enable_memclean: type: boolean x-go-name: EnableMemclean enable_tpm: type: boolean x-go-name: EnableTpm 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 extra_cpu_count: description: 额外分配 cpu 数量 format: int64 type: integer x-go-name: ExtraCpuCount 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: default: false 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 kickstart_config: $ref: '#/definitions/KickstartConfig' 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: $ref: '#/definitions/TNetChargeType' release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt 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: 关机后自动删除 enum: - stop - terminate - stop_release_gpu 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 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 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 ip6_addr: description: 通过IP6 addr解绑网卡, 优先级高于mac type: string x-go-name: Ip6Addr 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 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: prepaid, 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 containers: description: 容器描述信息 items: $ref: '#/definitions/PodContainerDesc' type: array x-go-name: Containers cpu_numa_pin: description: CPU 内存绑定信息 type: object x-go-name: CpuNumaPin 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 disks_snapshotpolicy_count: description: 磁盘快照策略数量 format: int64 type: integer x-go-name: DisksSnapshotpolicyCount 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 extra_cpu_count: description: 额外分配的 CPU 数量 format: int64 type: integer x-go-name: ExtraCpuCount 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 health_status: description: 健康状态, 仅开机中火运行中有效， 目前只支持阿里云 type: string x-go-name: HealthStatus host: description: 宿主机名称 type: string x-go-name: Host host_access_ip: description: 宿主机管理IP type: string x-go-name: HostAccessIp host_access_mac: description: 宿主机MAC type: string x-go-name: HostAccessMac host_billing_type: $ref: '#/definitions/TBillingType' host_eip: description: 宿主机公网IP（如果有） type: string x-go-name: HostEIP host_enabled: description: 宿主是否启用 type: boolean x-go-name: HostEnabled host_id: type: string x-go-name: HostId host_resource_type: type: string x-go-name: HostResourceType 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 last_start_at: description: 上次开机时间 format: date-time type: string x-go-name: LastStartAt 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 network_secgroups: description: 网卡级别安全组 items: $ref: '#/definitions/GuestnetworkSecgroupShortDesc' type: array x-go-name: NetworkSecgroups networks: description: |- details 网络概要 type: string x-go-name: Networks nics: description: 网卡信息 items: $ref: '#/definitions/GuestnetworkShortDesc' type: array x-go-name: Nics org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 release_at: description: 到期释放时间 format: date-time type: string x-go-name: ReleaseAt rescue_mode: description: Used for guest rescue type: boolean x-go-name: RescueMode resource_pool: description: 资源池,仅vmware指定调度标签时内部使用 type: string x-go-name: ResourcePool 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 snapshotpolicy_count: description: 主机快照策略数量 format: int64 type: integer x-go-name: SnapshotpolicyCount 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 ServerGetNumaInfoResp: properties: cpu_numa_pin: type: object x-go-name: CpuNumaPin isolated_devices_numa_node: items: format: int8 type: integer type: array x-go-name: IsolatedDevicesNumaNode 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_id: type: string x-go-name: PreferHostId reset_cpu_numa_pin: type: boolean x-go-name: ResetCpuNumaPin 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 x-go-name: COMMAND qmp: type: boolean x-go-name: QMP type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ServerNicTrafficLimit: properties: billing_type: $ref: '#/definitions/TBillingType' charge_type: $ref: '#/definitions/TNetChargeType' 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 ServerPerformStatusInput: properties: containers: additionalProperties: $ref: '#/definitions/ContainerPerformStatusInput' type: object x-go-name: Containers 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/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 x-go-name: Command timeout: description: qga execute timeout second format: int64 type: integer x-go-name: Timeout 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 x-go-name: Password username: type: string x-go-name: Username type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ServerQgaTimeoutInput: properties: timeout: description: qga execute timeout second format: int64 type: integer x-go-name: Timeout 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 image_id: description: |- 关机且停机不收费情况下不允许重装系统 镜像 id type: string x-go-name: ImageId 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 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_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: auto_start: default: false description: |- 保存镜像后是否自动启动,若实例状态为运行中,则会先关闭实例 公有云若支持开机保存镜像，此参数则不生效 type: boolean x-go-name: AutoStart format: description: 镜像格式 type: string x-go-name: Format generate_name: type: string x-go-name: GenerateName is_public: type: boolean x-go-name: IsPublic name: description: 镜像名称 type: string x-go-name: Name notes: type: string x-go-name: Notes 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 ServerSetNetworkNumQueuesInput: properties: mac_addr: description: 虚机网卡 mac addr type: string x-go-name: MacAddr num_queues: description: 网卡队列数 format: int64 type: integer x-go-name: NumQueues 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: auto_start: type: boolean x-go-name: AutoStart password: type: string x-go-name: Password reset_password: description: deploy params type: boolean x-go-name: ResetPassword username: type: string x-go-name: Username 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 prefer_host_id: description: |- Perfer clone destination host 指定期望的迁移目标宿主机 type: string x-go-name: PreferHostId type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute ServerSnapshotpolicyInput: description: 主机快照策略绑定/设置接口入参 properties: snapshotpolicy_id: description: 快照策略ID type: string x-go-name: SnapshotpolicyId 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 timeout_secs: description: 关机等待时间，如果是强制关机，则等待时间为0，如果不设置，默认为30秒 format: int64 type: integer x-go-name: TimeoutSecs 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 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 ServerUpdateKickstartStatusInput: description: ServerUpdateKickstartStatusInput 更新虚拟机 kickstart 状态的输入 properties: error_message: description: 错误信息（可选） type: string x-go-name: ErrorMessage status: description: kickstart 状态 enum: - kickstart_pending - kickstart_installing - kickstart_completed - kickstart_failed type: string x-go-name: Status required: - status 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 cookie: description: sangfor type: string x-go-name: Cookie 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: billing_type: description: 计费类型 type: string x-go-name: BillingType bps: description: 磁盘吞吐 format: int64 type: integer x-go-name: Bps 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 iops: description: 磁盘并发数 format: int64 type: integer x-go-name: Iops name: description: 主机名称 type: string x-go-name: Name snapshotpolicy: description: 磁盘绑定的快照策略列表 items: $ref: '#/definitions/SimpleSnapshotPolicy' type: array x-go-name: Snapshotpolicy 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 x-go-name: Id name: type: string x-go-name: Name 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: 快照大小, MiB 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 virtual_size: description: 磁盘大小, MiB format: int64 type: integer x-go-name: VirtualSize type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute SimpleSnapshotPolicy: properties: id: description: 快照策略ID type: string x-go-name: Id name: description: 快照策略名称 type: string x-go-name: Name repeat_weekdays: description: 快照策略重复周期 items: format: int64 type: integer type: array x-go-name: RepeatWeekdays resource_type: description: 快照策略类型 type: string x-go-name: ResourceType time_points: description: 快照策略时间点 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_backup_id: type: string x-go-name: DiskBackupId 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: description: 存储名称 type: string x-go-name: Storage 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 virtual_size: description: Virtual size, for kvm is origin disk size format: int64 type: integer x-go-name: VirtualSize 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: description: 绑定磁盘数量 format: int64 type: integer x-go-name: BindingDiskCount binding_resource_count: description: 绑定主机数量 format: int64 type: integer x-go-name: BindingResourceCount 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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, 7 is Sunday items: format: int64 type: integer type: array x-go-name: RepeatWeekdays retention_count: description: 快照保留数量, 优先级高于 RetentionDays, 且仅对本地IDC资源有效 format: int64 type: integer x-go-name: RetentionCount retention_days: description: '快照保留天数, -1: 表示永久保留' format: int64 type: integer x-go-name: RetentionDays snapshot_count: description: 快照数量 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 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, 每小时 创建自动快照策略的时间必须与 RepeatWeekdays 对应的创建周期相一致 items: format: int64 type: integer type: array x-go-name: TimePoints type: description: |- 快照类型, 目前支持 disk, server disk: 自动磁盘快照策略， 只能关联磁盘 server: 自动主机快照策略, 只能关联主机 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 SnapshotPolicyDisksInput: properties: disk: description: |- 磁盘ID列表 快照策略类型需要时disk items: type: string type: array x-go-name: Disks type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute SnapshotPolicyResourcesInput: properties: resources: description: |- 绑定的资源列表 目前仅支持绑定主机 items: properties: id: description: 绑定资源ID type: string x-go-name: Id type: description: 'server: 主机, disk: 磁盘' type: string x-go-name: Type type: object type: array x-go-name: Resources 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: status_info: items: $ref: '#/definitions/StatusStatisticStatusInfo' type: array x-go-name: StatusInfo total_cpu_count: description: CPU总量 format: int64 type: integer x-go-name: TotalCpuCount total_disk_size_mb: description: 存储总量 format: int64 type: integer x-go-name: TotalDiskSizeMb total_mem_size_mb: description: 内存总量 format: int64 type: integer x-go-name: TotalMemSizeMb type: object x-go-package: yunion.io/x/onecloud/pkg/apis StatusStatisticStatusInfo: properties: pending_deleted_count: description: |- 回收站数量 需要指定pending_delete=all format: int64 type: integer x-go-name: PendingDeletedCount status: type: string x-go-name: Status 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 auto_cache_images: description: rbd storage auto cache glance images type: boolean x-go-name: AutoCacheImages clvm_vg_name: description: CLVM VG Name type: string x-go-name: CLVMVgName 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_messenger_v2: description: enable ceph messenger v2 type: boolean x-go-name: EnableMessengerV2 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 lvmlockd: type: boolean x-go-name: Lvmlockd 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 slvm_vg_name: description: SLVM VG Name type: string x-go-name: SLVMVgName 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: 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 disk_count: 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 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 host_count: format: int64 type: integer x-go-name: HostCount 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 master_host_name: description: master host name type: string x-go-name: MasterHostName 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 snapshot_count: 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_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: format: int64 type: integer x-go-name: Used 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 wasted: format: int64 type: integer x-go-name: Wasted 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: host_status: type: string x-go-name: HostStatus id: type: string x-go-name: Id name: type: string x-go-name: Name status: type: string x-go-name: Status type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute StorageInfo: properties: id: type: string x-go-name: Id medium_type: type: string x-go-name: MediumType name: type: string x-go-name: Name storage_type: type: string x-go-name: StorageType 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 StorageSetCmtBoundInput: properties: Cmtbound: format: float type: number 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: auto_cache_images: description: rbd storage auto cache glance images type: boolean x-go-name: AutoCacheImages description: description: 资源描述 type: string x-go-name: Description enable_messenger_v2: description: enable ceph messenger v2 type: boolean x-go-name: EnableMessengerV2 master_host: type: string x-go-name: MasterHost 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 update_storage_conf: type: boolean x-go-name: UpdateStorageConf 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 cachedimage_id: description: 镜像缓存Id type: string x-go-name: CachedimageId can_delete: description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 example: true type: boolean x-go-name: CanDelete can_update: description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 example: true type: boolean x-go-name: CanUpdate cdrom_reference: description: Cdrom引用次数 format: int64 type: integer x-go-name: CdromReference 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 disk_reference: description: Disk引用次数 format: int64 type: integer x-go-name: DiskReference download_refcnt: description: 下载引用次数 format: int64 type: integer x-go-name: DownloadRefcnt environment: description: Environment type: string x-go-name: Environment external_id: description: 云上Id, 对应云上资源自身Id type: string x-go-name: ExternalId host_info: description: 关联宿主机信息 items: $ref: '#/definitions/HostInfo' type: array x-go-name: HostInfo hosts: description: 关联宿主机名称 items: type: string type: array x-go-name: Hosts image: description: 镜像名称 type: string x-go-name: Image imported_at: description: 资源导入时间 format: date-time type: string x-go-name: ImportedAt last_download: description: 上次下载时间 format: date-time type: string x-go-name: LastDownload 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 path: type: string x-go-name: Path provider: description: 云平台名称 example: Google type: string x-go-name: Provider reference: description: 引用次数 format: int64 type: integer x-go-name: Reference row_id: format: int64 type: integer x-go-name: RowId size: description: 镜像大小 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_info: description: 关联存储信息 items: $ref: '#/definitions/StorageInfo' type: array x-go-name: StorageInfo storagecache: description: 存储缓存名称 type: string x-go-name: Storagecache storagecache_id: description: 存储缓存Id type: string x-go-name: StoragecacheId 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 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 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 TBillingType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/billing 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 TNetChargeType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/billing TNetworkAddressParentType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/compute TNetworkType: type: string x-go-package: yunion.io/x/onecloud/pkg/apis/compute 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: 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 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 URIScheme: description: URIScheme identifies the scheme used for connection to a host for Get actions type: string x-go-package: yunion.io/x/onecloud/pkg/apis 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 ValidateIPMIRequest: 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/baremetal ValidateIPMIResponse: properties: ipmi_system_info: x-go-name: IPMISystemInfo is_redfish_supported: type: boolean x-go-name: IsRedfishSupported redfish_system_info: $ref: '#/definitions/RedfishSystemInfo' type: object x-go-package: yunion.io/x/onecloud/pkg/apis/baremetal 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 x-go-name: Bandwidth 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 peer_vpc_id: type: string x-go-name: PeerVpcId 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: 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 peer_vpc_name: type: string x-go-name: PeerVpcName 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 WafIPSetDetails: 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 addresses: $ref: '#/definitions/WafAddresses' 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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 WafInstanceCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata cloud_resources: description: |- 关联云资源列表 阿里云要求输入此参数或source_ips items: $ref: '#/definitions/SCloudResource' type: array x-go-name: CloudResources cloudprovider_id: description: 列出关联指定云订阅(ID或Name)的资源 type: string x-go-name: CloudproviderId cloudregion_id: description: 区域名称或ID type: string x-go-name: CloudregionId default_action: $ref: '#/definitions/DefaultAction' 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 type: $ref: '#/definitions/TWafType' required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute WafInstanceDetails: properties: access_headers: items: type: string type: array x-go-name: AccessHeaders 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 cc_list: description: 回源地址 items: type: string type: array x-go-name: CcList cert_id: type: string x-go-name: CertId cert_name: type: string x-go-name: CertName 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 cname: type: string x-go-name: Cname 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 http_ports: items: format: int64 type: integer type: array x-go-name: HttpPorts https_ports: items: format: int64 type: integer type: array x-go-name: HttpsPorts id: description: 资源UUID type: string x-go-name: Id imported_at: description: 资源导入时间 format: date-time type: string x-go-name: ImportedAt is_access_product: description: 前面是否有代理服务 type: boolean x-go-name: IsAccessProduct 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 rules: items: $ref: '#/definitions/SWafRule' 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 source: description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' type: string x-go-name: Source source_ips: description: 源站地址 items: type: string type: array x-go-name: SourceIps 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 upstream_port: format: int64 type: integer x-go-name: UpstreamPort upstream_scheme: type: string x-go-name: UpstreamScheme 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 WafRegexSetDetails: 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 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: 云订阅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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 regex_patterns: $ref: '#/definitions/WafRegexPatterns' 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 WafRuleCreateInput: properties: __meta__: additionalProperties: type: string description: 标签列表,最多支持20个 example: user:rd: op type: object x-go-name: Metadata action: $ref: '#/definitions/DefaultAction' config: description: 规则配置 type: object x-go-name: Config 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 expression: description: 规则表达式 type: string x-go-name: Expression 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 statements: description: 条件表达式 items: $ref: '#/definitions/SWafStatement' type: array x-go-name: Statements status: description: 用来存储资源的状态 type: string x-go-name: Status type: description: 规则类型 type: string x-go-name: Type waf_instance_id: description: WAF实例Id type: string x-go-name: WafInstanceId required: - name type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute WafRuleDetails: properties: 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 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 description: description: 资源描述信息 type: string x-go-name: Description enabled: description: 资源是否启用 type: boolean x-go-name: Enabled expression: description: 条件表达式 type: string x-go-name: Expression 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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 statements: items: $ref: '#/definitions/SWafStatement' type: array x-go-name: Statements status: description: 资源状态 type: string x-go-name: Status type: description: 规则类型 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_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 WafRuleDisableInput: type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute WafRuleEnableInput: type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute WafRuleGroupDetails: 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 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: 云订阅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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 waf_type: type: string x-go-name: WafType type: object x-go-package: yunion.io/x/onecloud/pkg/apis/compute WafRuleUpdateInput: properties: action: $ref: '#/definitions/DefaultAction' config: description: 规则配置 type: object x-go-name: Config description: description: 资源描述 type: string x-go-name: Description expression: description: 规则表达式 type: string x-go-name: Expression name: description: 资源名称 type: string x-go-name: Name priority: description: 优先级 format: int64 type: integer x-go-name: Priority progress: format: float type: number x-go-name: Progress statements: description: 条件表达式 items: $ref: '#/definitions/SWafStatement' type: array x-go-name: Statements 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 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 progress: description: 操作进度0-100 format: float type: number x-go-name: Progress project_domain: description: 资源归属项目的域名称 type: string x-go-name: ProjectDomain provider: description: 云平台名称 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 x-go-name: Cloudregion 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 org_node_md5: description: 用以组织架构变更通知其他服务权限变更 type: string x-go-name: OrgNodeMd5 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: Cloudprovider API license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html version: "1.0" paths: /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: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - 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}/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}/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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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}/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}/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 /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 /ai_gateways: get: description: 列表 operationId: ai_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/ai_gateway_ListItemFilterOutput' summary: AI网关列表 tags: - ai_gateway post: description: 新建 operationId: ai_gateway_ValidateCreateData parameters: - in: body name: body schema: properties: ai_gateway: $ref: '#/definitions/AiGatewayCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/ai_gateway_ValidateCreateDataOutput' summary: 新建 tags: - ai_gateway /ai_gateways/{id}: delete: description: 删除 operationId: ai_gateway_CustomizeDelete parameters: - description: The Id or Name of ai_gateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/ai_gateway_CustomizeDeleteOutput' summary: 删除 tags: - ai_gateway get: description: 获取详情 operationId: ai_gateway_FetchCustomizeColumns parameters: - description: The Id or Name of ai_gateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/ai_gateway_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - ai_gateway put: description: 更新 operationId: ai_gateway_ValidateUpdateData parameters: - description: The Id or Name of ai_gateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: ai_gateway: $ref: '#/definitions/AiGatewayUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/ai_gateway_ValidateUpdateDataOutput' summary: 更新 tags: - ai_gateway /ai_gateways/{id}/change-config: post: description: 执行操作ChangeConfig operationId: ai_gateway_PerformChangeConfig parameters: - description: The Id or Name of ai_gateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: ai_gateway: $ref: '#/definitions/AiGatewayChangeConfigOptions' type: object x-go-name: Body responses: "200": $ref: '#/responses/ai_gateway_PerformChangeConfigOutput' summary: 更改配置 tags: - ai_gateway /ai_gateways/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: ai_gateway_PerformChangeOwner parameters: - description: The Id or Name of ai_gateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: ai_gateway: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/ai_gateway_PerformChangeOwnerOutput' summary: 更改项目 tags: - ai_gateway /ai_gateways/{id}/metadata: get: description: 获取指定信息Metadata operationId: ai_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 ai_gateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/ai_gateway_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - ai_gateway /ai_gateways/{id}/status: get: description: 获取指定信息Status operationId: ai_gateway_GetDetailsStatus parameters: - description: The Id or Name of ai_gateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/ai_gateway_GetDetailsStatusOutput' summary: 获取资源状态 tags: - ai_gateway /ai_gateways/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: ai_gateway_PerformSyncstatus parameters: - description: The Id or Name of ai_gateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/ai_gateway_PerformSyncstatusOutput' summary: 同步状态 tags: - ai_gateway /backupstorages: get: description: 列表 operationId: 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: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 指定项目归属域名称或ID in: query name: project_domain_id type: string x-go-name: ProjectDomainId - description: 对具有域属性的资源，严格匹配域ID in: query items: type: string name: project_domain_ids type: array x-go-name: ProjectDomainIds - description: 按domain名称排序，可能值为asc|desc in: query name: order_by_domain pattern: asc|desc type: string x-go-name: OrderByDomain - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: domain_tags x-go-name: DomainTags - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: no_domain_tags x-go-name: NoDomainTags - description: 以资源是否共享过滤列表 in: query name: is_public type: boolean x-go-name: IsPublic - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project in: query name: public_scope type: string x-go-name: PublicScope - description: 以资源的状态过滤列表 in: query items: type: string name: status type: array x-go-name: Status - description: 以资源是否启用/禁用过滤列表 in: query 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/backupstorage_ListItemFilterOutput' summary: 列表 tags: - backupstorage post: description: 新建 operationId: backupstorage_ValidateCreateData parameters: - in: body name: body schema: properties: backupstorage: $ref: '#/definitions/BackupStorageCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/backupstorage_ValidateCreateDataOutput' summary: 新建 tags: - backupstorage /backupstorages/{id}: delete: description: 删除 operationId: backupstorage_CustomizeDelete parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/backupstorage_CustomizeDeleteOutput' summary: 删除 tags: - backupstorage get: description: 获取详情 operationId: backupstorage_FetchCustomizeColumns parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/backupstorage_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - backupstorage put: description: 更新 operationId: backupstorage_ValidateUpdateData parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: backupstorage: $ref: '#/definitions/BackupStorageUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/backupstorage_ValidateUpdateDataOutput' summary: 更新 tags: - backupstorage /backupstorages/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: backupstorage_PerformChangeOwner parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: backupstorage: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/backupstorage_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - backupstorage /backupstorages/{id}/disable: post: description: 执行操作Disable operationId: backupstorage_PerformDisable parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: backupstorage: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/backupstorage_PerformDisableOutput' summary: 禁用资源 tags: - backupstorage /backupstorages/{id}/enable: post: description: 执行操作Enable operationId: backupstorage_PerformEnable parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: backupstorage: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/backupstorage_PerformEnableOutput' summary: 启用资源 tags: - backupstorage /backupstorages/{id}/metadata: get: description: 获取指定信息Metadata operationId: backupstorage_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/backupstorage_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - backupstorage /backupstorages/{id}/private: post: description: 执行操作Private operationId: backupstorage_PerformPrivate parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: backupstorage: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/backupstorage_PerformPrivateOutput' summary: 执行操作Private tags: - backupstorage /backupstorages/{id}/public: post: description: 执行操作Public operationId: backupstorage_PerformPublic parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: backupstorage: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/backupstorage_PerformPublicOutput' summary: 执行操作Public tags: - backupstorage /backupstorages/{id}/status: get: description: 获取指定信息Status operationId: backupstorage_GetDetailsStatus parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/backupstorage_GetDetailsStatusOutput' summary: 获取资源状态 tags: - backupstorage /backupstorages/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: backupstorage_PerformSyncstatus parameters: - description: The Id or Name of backupstorage in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: backupstorage: $ref: '#/definitions/DiskBackupSyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/backupstorage_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - backupstorage /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 区域名称或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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 items: type: string name: resource_type type: array x-go-name: ResourceType 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/VirtualResourceCreateInput' 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/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/billing_resource_check_ValidateUpdateDataOutput' summary: 更新 tags: - billing_resource_check /billing_resource_checks/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: billing_resource_check_PerformChangeOwner 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/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/billing_resource_check_PerformChangeOwnerOutput' summary: 更改项目 tags: - billing_resource_check /billing_resource_checks/{id}/metadata: get: description: 获取指定信息Metadata operationId: billing_resource_check_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - 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_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - billing_resource_check /billing_resource_checks/{id}/status: get: description: 获取指定信息Status operationId: billing_resource_check_GetDetailsStatus 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_GetDetailsStatusOutput' summary: 获取资源状态 tags: - billing_resource_check /billing_resource_checks/check: post: description: 执行操作Check operationId: billing_resource_check_PerformCheck responses: "200": $ref: '#/responses/billing_resource_check_PerformCheckOutput' summary: 执行操作Check 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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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}/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-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-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 /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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - enum: - public - private in: query name: cloud_env type: string x-go-name: CloudEnv 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}/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: 更改项目 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}/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 /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/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/add-custom-hostname: post: description: 执行操作AddCustomHostname operationId: cdn_domain_PerformAddCustomHostname 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/CustomHostnameCreateOptions' type: object x-go-name: Body responses: "200": $ref: '#/responses/cdn_domain_PerformAddCustomHostnameOutput' summary: 执行操作AddCustomHostname tags: - cdn_domain /cdn_domains/{id}/change-config: post: description: 执行操作ChangeConfig operationId: cdn_domain_PerformChangeConfig 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/CacheConfig' type: object x-go-name: Body responses: "200": $ref: '#/responses/cdn_domain_PerformChangeConfigOutput' summary: 执行操作ChangeConfig 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: 更改项目 tags: - cdn_domain /cdn_domains/{id}/clear-cache: post: description: 执行操作ClearCache operationId: cdn_domain_PerformClearCache 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/CacheClearOptions' type: object x-go-name: Body responses: "200": $ref: '#/responses/cdn_domain_PerformClearCacheOutput' summary: 执行操作ClearCache tags: - cdn_domain /cdn_domains/{id}/custom-hostnames: get: description: 获取指定信息CustomHostnames operationId: cdn_domain_GetDetailsCustomHostnames 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_GetDetailsCustomHostnamesOutput' summary: 获取指定信息CustomHostnames tags: - cdn_domain /cdn_domains/{id}/delete-custom-hostname: post: description: 执行操作DeleteCustomHostname operationId: cdn_domain_PerformDeleteCustomHostname 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/CDNDeleteCustomHostnameInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cdn_domain_PerformDeleteCustomHostnameOutput' summary: 执行操作DeleteCustomHostname 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}/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}/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 /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 /cloud_kube_clusters: get: description: 列表 operationId: cloud_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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/cloud_kube_cluster_ListItemFilterOutput' summary: 列出Kube Cluster tags: - cloud_kube_cluster post: description: 新建 operationId: cloud_kube_cluster_ValidateCreateData parameters: - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/KubeClusterCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_ValidateCreateDataOutput' summary: 新建 tags: - cloud_kube_cluster /cloud_kube_clusters/{id}: delete: description: 删除 operationId: cloud_kube_cluster_CustomizeDelete parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/KubeClusterDeleteInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_CustomizeDeleteOutput' summary: 删除 tags: - cloud_kube_cluster get: description: 获取详情 operationId: cloud_kube_cluster_FetchCustomizeColumns parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_cluster_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - cloud_kube_cluster put: description: 更新 operationId: cloud_kube_cluster_ValidateUpdateData parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/KubeClusterUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_ValidateUpdateDataOutput' summary: 更新 tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: cloud_kube_cluster_PerformChangeOwner parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/disable: post: description: 执行操作Disable operationId: cloud_kube_cluster_PerformDisable parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_PerformDisableOutput' summary: 禁用资源 tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/enable: post: description: 执行操作Enable operationId: cloud_kube_cluster_PerformEnable parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_PerformEnableOutput' summary: 启用资源 tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/kubeconfig: get: description: 获取指定信息Kubeconfig operationId: cloud_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 cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_cluster_GetDetailsKubeconfigOutput' summary: 获取指定信息Kubeconfig tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/metadata: get: description: 获取指定信息Metadata operationId: cloud_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 cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_cluster_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/private: post: description: 执行操作Private operationId: cloud_kube_cluster_PerformPrivate parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_PerformPrivateOutput' summary: 执行操作Private tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/public: post: description: 执行操作Public operationId: cloud_kube_cluster_PerformPublic parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_PerformPublicOutput' summary: 执行操作Public tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/status: get: description: 获取指定信息Status operationId: cloud_kube_cluster_GetDetailsStatus parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_cluster_GetDetailsStatusOutput' summary: 获取资源状态 tags: - cloud_kube_cluster /cloud_kube_clusters/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: cloud_kube_cluster_PerformSyncstatus parameters: - description: The Id or Name of cloud_kube_cluster in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_cluster: $ref: '#/definitions/SyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_cluster_PerformSyncstatusOutput' summary: 同步Kube Cluster状态 tags: - cloud_kube_cluster /cloud_kube_node_pools: get: description: 列表 operationId: cloud_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/cloud_kube_node_pool_ListItemFilterOutput' summary: Kube Node Pool列表 tags: - cloud_kube_node_pool post: description: 新建 operationId: cloud_kube_node_pool_ValidateCreateData parameters: - in: body name: body schema: properties: cloud_kube_node_pool: $ref: '#/definitions/KubeNodePoolCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_node_pool_ValidateCreateDataOutput' summary: 新建 tags: - cloud_kube_node_pool /cloud_kube_node_pools/{id}: delete: description: 删除 operationId: cloud_kube_node_pool_CustomizeDelete parameters: - description: The Id or Name of cloud_kube_node_pool in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_node_pool_CustomizeDeleteOutput' summary: 删除 tags: - cloud_kube_node_pool get: description: 获取详情 operationId: cloud_kube_node_pool_FetchCustomizeColumns parameters: - description: The Id or Name of cloud_kube_node_pool in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_node_pool_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - cloud_kube_node_pool put: description: 更新 operationId: cloud_kube_node_pool_ValidateUpdateData parameters: - description: The Id or Name of cloud_kube_node_pool in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_node_pool: $ref: '#/definitions/KubeNodePoolUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_node_pool_ValidateUpdateDataOutput' summary: 更新 tags: - cloud_kube_node_pool /cloud_kube_node_pools/{id}/metadata: get: description: 获取指定信息Metadata operationId: cloud_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 cloud_kube_node_pool in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_node_pool_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - cloud_kube_node_pool /cloud_kube_node_pools/{id}/status: get: description: 获取指定信息Status operationId: cloud_kube_node_pool_GetDetailsStatus parameters: - description: The Id or Name of cloud_kube_node_pool in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_node_pool_GetDetailsStatusOutput' summary: 获取资源状态 tags: - cloud_kube_node_pool /cloud_kube_node_pools/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: cloud_kube_node_pool_PerformSyncstatus parameters: - description: The Id or Name of cloud_kube_node_pool in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_node_pool: $ref: '#/definitions/SyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_node_pool_PerformSyncstatusOutput' summary: 同步Kube Node Pool 状态 tags: - cloud_kube_node_pool /cloud_kube_nodes: get: description: 列表 operationId: cloud_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/cloud_kube_node_ListItemFilterOutput' summary: Kube Node列表 tags: - cloud_kube_node post: description: 新建 operationId: cloud_kube_node_ValidateCreateData parameters: - in: body name: body schema: properties: cloud_kube_node: $ref: '#/definitions/KubeNodeCreateInput' count: default: 1 format: int64 type: integer x-go-name: Count type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_node_ValidateCreateDataOutput' summary: 新建 tags: - cloud_kube_node /cloud_kube_nodes/{id}: delete: description: 删除 operationId: cloud_kube_node_CustomizeDelete parameters: - description: The Id or Name of cloud_kube_node in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_node_CustomizeDeleteOutput' summary: 删除 tags: - cloud_kube_node get: description: 获取详情 operationId: cloud_kube_node_FetchCustomizeColumns parameters: - description: The Id or Name of cloud_kube_node in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_node_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - cloud_kube_node put: description: 更新 operationId: cloud_kube_node_ValidateUpdateData parameters: - description: The Id or Name of cloud_kube_node in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: cloud_kube_node: $ref: '#/definitions/KubeNodeUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloud_kube_node_ValidateUpdateDataOutput' summary: 更新 tags: - cloud_kube_node /cloud_kube_nodes/{id}/metadata: get: description: 获取指定信息Metadata operationId: cloud_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 cloud_kube_node in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_node_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - cloud_kube_node /cloud_kube_nodes/{id}/status: get: description: 获取指定信息Status operationId: cloud_kube_node_GetDetailsStatus parameters: - description: The Id or Name of cloud_kube_node in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/cloud_kube_node_GetDetailsStatusOutput' summary: 获取资源状态 tags: - cloud_kube_node /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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-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}/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}/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 /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 - in: body name: body schema: properties: cloudaccount: $ref: '#/definitions/SCloudaccountCredential' type: object x-go-name: Body responses: "200": $ref: '#/responses/cloudaccount_PerformUpdateCredentialOutput' summary: 执行操作UpdateCredential 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 /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: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - 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 - 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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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-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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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}/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-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}/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 /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/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - in: query name: host_id type: string x-go-name: HostId 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 responses: "200": $ref: '#/responses/container_ValidateUpdateDataOutput' summary: func (c *SContainer) ValidateUpdateData(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, input *api.ContainerUpdateInput) (*api.ContainerUpdateInput, error) { tags: - container /containers/{id}/add-volume-mount-post-overlay: post: description: 执行操作AddVolumeMountPostOverlay operationId: container_PerformAddVolumeMountPostOverlay 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/ContainerVolumeMountAddPostOverlayInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/container_PerformAddVolumeMountPostOverlayOutput' summary: 执行操作AddVolumeMountPostOverlay 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: 更改项目 tags: - container /containers/{id}/commit: post: description: 执行操作Commit operationId: container_PerformCommit 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/ContainerCommitInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/container_PerformCommitOutput' summary: 执行操作Commit 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}/exec-sync: post: description: 执行操作ExecSync operationId: container_PerformExecSync 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/ContainerExecSyncInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/container_PerformExecSyncOutput' summary: 执行操作ExecSync 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}/remove-volume-mount-post-overlay: post: description: 执行操作RemoveVolumeMountPostOverlay operationId: container_PerformRemoveVolumeMountPostOverlay 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/ContainerVolumeMountRemovePostOverlayInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/container_PerformRemoveVolumeMountPostOverlayOutput' summary: 执行操作RemoveVolumeMountPostOverlay tags: - container /containers/{id}/restart: post: description: 执行操作Restart operationId: container_PerformRestart 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/ContainerRestartInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/container_PerformRestartOutput' summary: 执行操作Restart 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-resources-limit: post: description: 执行操作SetResourcesLimit operationId: container_PerformSetResourcesLimit 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/ContainerResourcesSetInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/container_PerformSetResourcesLimitOutput' summary: 执行操作SetResourcesLimit 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/ContainerPerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/container_PerformStatusOutput' summary: 执行操作Status 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 /dbinstance_skus: get: description: 列表 operationId: dbinstance_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/dbinstance_sku_ListItemFilterOutput' summary: RDS套餐类型列表 tags: - dbinstance_sku post: description: 新建 operationId: dbinstance_sku_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count dbinstance_sku: $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_sku_ValidateCreateDataOutput' summary: 新建 tags: - dbinstance_sku /dbinstance_skus/{id}: delete: description: 删除 operationId: dbinstance_sku_CustomizeDelete parameters: - description: The Id or Name of dbinstance_sku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_sku_CustomizeDeleteOutput' summary: 删除 tags: - dbinstance_sku get: description: 获取详情 operationId: dbinstance_sku_FetchCustomizeColumns parameters: - description: The Id or Name of dbinstance_sku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_sku_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - dbinstance_sku put: description: 更新 operationId: dbinstance_sku_ValidateUpdateData parameters: - description: The Id or Name of dbinstance_sku in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance_sku: $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_sku_ValidateUpdateDataOutput' summary: 更新 tags: - dbinstance_sku /dbinstance_skus/{id}/disable: post: description: 执行操作Disable operationId: dbinstance_sku_PerformDisable parameters: - description: The Id or Name of dbinstance_sku in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance_sku: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_sku_PerformDisableOutput' summary: 禁用资源 tags: - dbinstance_sku /dbinstance_skus/{id}/enable: post: description: 执行操作Enable operationId: dbinstance_sku_PerformEnable parameters: - description: The Id or Name of dbinstance_sku in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance_sku: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_sku_PerformEnableOutput' summary: 启用资源 tags: - dbinstance_sku /dbinstance_skus/{id}/metadata: get: description: 获取指定信息Metadata operationId: dbinstance_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 dbinstance_sku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_sku_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - dbinstance_sku /dbinstance_skus/{id}/status: get: description: 获取指定信息Status operationId: dbinstance_sku_GetDetailsStatus parameters: - description: The Id or Name of dbinstance_sku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_sku_GetDetailsStatusOutput' summary: 获取资源状态 tags: - dbinstance_sku /dbinstance_skus/instance-specs: get: description: 获取指定资源类的信息InstanceSpecs operationId: dbinstance_sku_GetPropertyInstanceSpecs responses: "200": $ref: '#/responses/dbinstance_sku_GetPropertyInstanceSpecsOutput' summary: 获取指定资源类的信息InstanceSpecs tags: - dbinstance_sku /dbinstance_skus/sync-skus: post: description: 执行操作SyncSkus operationId: dbinstance_sku_PerformSyncSkus parameters: - in: body name: body schema: properties: dbinstance_sku: $ref: '#/definitions/SkuSyncInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_sku_PerformSyncSkusOutput' summary: 执行操作SyncSkus tags: - dbinstance_sku /dbinstance_skus/sync-tasks: get: description: 获取指定资源类的信息SyncTasks operationId: dbinstance_sku_GetPropertySyncTasks parameters: - description: 异步任务ID in: query items: type: string name: task_ids type: array x-go-name: TaskIds responses: "200": $ref: '#/responses/dbinstance_sku_GetPropertySyncTasksOutput' summary: 获取指定资源类的信息SyncTasks tags: - dbinstance_sku /dbinstanceaccounts: get: description: 列表 operationId: dbinstanceaccount_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/dbinstanceaccount_ListItemFilterOutput' summary: RDS账号列表 tags: - dbinstanceaccount post: description: 新建 operationId: dbinstanceaccount_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count dbinstanceaccount: $ref: '#/definitions/DBInstanceAccountCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstanceaccount_ValidateCreateDataOutput' summary: 新建 tags: - dbinstanceaccount /dbinstanceaccounts/{id}: delete: description: 删除 operationId: dbinstanceaccount_CustomizeDelete parameters: - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceaccount_CustomizeDeleteOutput' summary: 删除 tags: - dbinstanceaccount get: description: 获取详情 operationId: dbinstanceaccount_FetchCustomizeColumns parameters: - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceaccount_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - dbinstanceaccount put: description: 更新 operationId: dbinstanceaccount_ValidateUpdateData parameters: - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstanceaccount: $ref: '#/definitions/DBInstanceAccountUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstanceaccount_ValidateUpdateDataOutput' summary: 更新 tags: - dbinstanceaccount /dbinstanceaccounts/{id}/grant-privilege: post: description: 执行操作GrantPrivilege operationId: dbinstanceaccount_PerformGrantPrivilege parameters: - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceaccount_PerformGrantPrivilegeOutput' summary: 执行操作GrantPrivilege tags: - dbinstanceaccount /dbinstanceaccounts/{id}/metadata: get: description: 获取指定信息Metadata operationId: dbinstanceaccount_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceaccount_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - dbinstanceaccount /dbinstanceaccounts/{id}/reset-password: post: description: 执行操作ResetPassword operationId: dbinstanceaccount_PerformResetPassword parameters: - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceaccount_PerformResetPasswordOutput' summary: 执行操作ResetPassword tags: - dbinstanceaccount /dbinstanceaccounts/{id}/revoke-privilege: post: description: 执行操作RevokePrivilege operationId: dbinstanceaccount_PerformRevokePrivilege parameters: - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceaccount_PerformRevokePrivilegeOutput' summary: 执行操作RevokePrivilege tags: - dbinstanceaccount /dbinstanceaccounts/{id}/set-privileges: post: description: 执行操作SetPrivileges operationId: dbinstanceaccount_PerformSetPrivileges parameters: - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceaccount_PerformSetPrivilegesOutput' summary: 执行操作SetPrivileges tags: - dbinstanceaccount /dbinstanceaccounts/{id}/status: get: description: 获取指定信息Status operationId: dbinstanceaccount_GetDetailsStatus parameters: - description: The Id or Name of dbinstanceaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceaccount_GetDetailsStatusOutput' summary: 获取资源状态 tags: - dbinstanceaccount /dbinstancebackups: get: description: 列表 operationId: dbinstancebackup_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/dbinstancebackup_ListItemFilterOutput' summary: RDS备份列表 tags: - dbinstancebackup post: description: 新建 operationId: dbinstancebackup_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count dbinstancebackup: $ref: '#/definitions/DBInstanceBackupCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstancebackup_ValidateCreateDataOutput' summary: 新建 tags: - dbinstancebackup /dbinstancebackups/{id}: delete: description: 删除 operationId: dbinstancebackup_CustomizeDelete parameters: - description: The Id or Name of dbinstancebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstancebackup_CustomizeDeleteOutput' summary: 删除 tags: - dbinstancebackup get: description: 获取详情 operationId: dbinstancebackup_FetchCustomizeColumns parameters: - description: The Id or Name of dbinstancebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstancebackup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - dbinstancebackup put: description: 更新 operationId: dbinstancebackup_ValidateUpdateData parameters: - description: The Id or Name of dbinstancebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstancebackup: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstancebackup_ValidateUpdateDataOutput' summary: 更新 tags: - dbinstancebackup /dbinstancebackups/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: dbinstancebackup_PerformChangeOwner parameters: - description: The Id or Name of dbinstancebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstancebackup: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstancebackup_PerformChangeOwnerOutput' summary: 更改项目 tags: - dbinstancebackup /dbinstancebackups/{id}/metadata: get: description: 获取指定信息Metadata operationId: dbinstancebackup_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of dbinstancebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstancebackup_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - dbinstancebackup /dbinstancebackups/{id}/status: get: description: 获取指定信息Status operationId: dbinstancebackup_GetDetailsStatus parameters: - description: The Id or Name of dbinstancebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstancebackup_GetDetailsStatusOutput' summary: 获取资源状态 tags: - dbinstancebackup /dbinstancebackups/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: dbinstancebackup_PerformSyncstatus parameters: - description: The Id or Name of dbinstancebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstancebackup: $ref: '#/definitions/DiskSyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstancebackup_PerformSyncstatusOutput' summary: 同步RDS备份状态 tags: - dbinstancebackup /dbinstancedatabases: get: description: 列表 operationId: dbinstancedatabase_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/dbinstancedatabase_ListItemFilterOutput' summary: RDS数据库列表 tags: - dbinstancedatabase post: description: 新建 operationId: dbinstancedatabase_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count dbinstancedatabase: $ref: '#/definitions/DBInstanceDatabaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstancedatabase_ValidateCreateDataOutput' summary: 新建 tags: - dbinstancedatabase /dbinstancedatabases/{id}: delete: description: 删除 operationId: dbinstancedatabase_CustomizeDelete parameters: - description: The Id or Name of dbinstancedatabase in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstancedatabase_CustomizeDeleteOutput' summary: 删除 tags: - dbinstancedatabase get: description: 获取详情 operationId: dbinstancedatabase_FetchCustomizeColumns parameters: - description: The Id or Name of dbinstancedatabase in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstancedatabase_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - dbinstancedatabase put: description: 更新 operationId: dbinstancedatabase_ValidateUpdateData parameters: - description: The Id or Name of dbinstancedatabase in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstancedatabase: $ref: '#/definitions/DBInstanceDatabaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstancedatabase_ValidateUpdateDataOutput' summary: 更新 tags: - dbinstancedatabase /dbinstancedatabases/{id}/metadata: get: description: 获取指定信息Metadata operationId: dbinstancedatabase_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of dbinstancedatabase in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstancedatabase_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - dbinstancedatabase /dbinstancedatabases/{id}/status: get: description: 获取指定信息Status operationId: dbinstancedatabase_GetDetailsStatus parameters: - description: The Id or Name of dbinstancedatabase in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstancedatabase_GetDetailsStatusOutput' summary: 获取资源状态 tags: - dbinstancedatabase /dbinstanceparameters: get: description: 列表 operationId: dbinstanceparameter_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源外部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 - 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/dbinstanceparameter_ListItemFilterOutput' summary: 列出数据参数 tags: - dbinstanceparameter post: description: 新建 operationId: dbinstanceparameter_ValidateCreateData responses: "200": $ref: '#/responses/dbinstanceparameter_ValidateCreateDataOutput' summary: 新建 tags: - dbinstanceparameter /dbinstanceparameters/{id}: delete: description: 删除 operationId: dbinstanceparameter_CustomizeDelete parameters: - description: The Id or Name of dbinstanceparameter in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceparameter_CustomizeDeleteOutput' summary: 删除 tags: - dbinstanceparameter get: description: 获取详情 operationId: dbinstanceparameter_FetchCustomizeColumns parameters: - description: The Id or Name of dbinstanceparameter in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceparameter_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - dbinstanceparameter put: description: 更新 operationId: dbinstanceparameter_ValidateUpdateData parameters: - description: The Id or Name of dbinstanceparameter in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstanceparameter: $ref: '#/definitions/StandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstanceparameter_ValidateUpdateDataOutput' summary: 更新 tags: - dbinstanceparameter /dbinstanceparameters/{id}/metadata: get: description: 获取指定信息Metadata operationId: dbinstanceparameter_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of dbinstanceparameter in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceparameter_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - dbinstanceparameter /dbinstanceprivileges: get: description: 列表 operationId: dbinstanceprivilege_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - 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/dbinstanceprivilege_ListItemFilterOutput' summary: 列表 tags: - dbinstanceprivilege post: description: 新建 operationId: dbinstanceprivilege_ValidateCreateData responses: "200": $ref: '#/responses/dbinstanceprivilege_ValidateCreateDataOutput' summary: 新建 tags: - dbinstanceprivilege /dbinstanceprivileges/{id}: delete: description: 删除 operationId: dbinstanceprivilege_CustomizeDelete parameters: - description: The Id or Name of dbinstanceprivilege in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceprivilege_CustomizeDeleteOutput' summary: 删除 tags: - dbinstanceprivilege get: description: 获取详情 operationId: dbinstanceprivilege_FetchCustomizeColumns parameters: - description: The Id or Name of dbinstanceprivilege in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstanceprivilege_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - dbinstanceprivilege put: description: 更新 operationId: dbinstanceprivilege_ValidateUpdateData parameters: - description: The Id or Name of dbinstanceprivilege in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstanceprivilege: $ref: '#/definitions/ResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstanceprivilege_ValidateUpdateDataOutput' summary: 更新 tags: - dbinstanceprivilege /dbinstances: get: description: 列表 operationId: dbinstance_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/dbinstance_ListItemFilterOutput' summary: RDS实例列表 tags: - dbinstance post: description: 新建 operationId: dbinstance_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count dbinstance: $ref: '#/definitions/DBInstanceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_ValidateCreateDataOutput' summary: 新建 tags: - dbinstance /dbinstances/{id}: delete: description: 删除 operationId: dbinstance_CustomizeDelete parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_CustomizeDeleteOutput' summary: 删除 tags: - dbinstance get: description: 获取详情 operationId: dbinstance_FetchCustomizeColumns parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - dbinstance put: description: 更新 operationId: dbinstance_ValidateUpdateData parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_ValidateUpdateDataOutput' summary: 更新 tags: - dbinstance /dbinstances/{id}/cancel-expire: post: description: 执行操作CancelExpire operationId: dbinstance_PerformCancelExpire parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_PerformCancelExpireOutput' summary: 执行操作CancelExpire tags: - dbinstance /dbinstances/{id}/change-config: post: description: 执行操作ChangeConfig operationId: dbinstance_PerformChangeConfig parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance: $ref: '#/definitions/SDBInstanceChangeConfigInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_PerformChangeConfigOutput' summary: 执行操作ChangeConfig tags: - dbinstance /dbinstances/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: dbinstance_PerformChangeOwner parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - dbinstance /dbinstances/{id}/metadata: get: description: 获取指定信息Metadata operationId: dbinstance_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - dbinstance /dbinstances/{id}/postpaid-expire: post: description: 执行操作PostpaidExpire operationId: dbinstance_PerformPostpaidExpire parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance: $ref: '#/definitions/PostpaidExpireInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_PerformPostpaidExpireOutput' summary: 执行操作PostpaidExpire tags: - dbinstance /dbinstances/{id}/public-connection: post: description: 执行操作PublicConnection operationId: dbinstance_PerformPublicConnection parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_PerformPublicConnectionOutput' summary: 执行操作PublicConnection tags: - dbinstance /dbinstances/{id}/purge: post: description: 执行操作Purge operationId: dbinstance_PerformPurge parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_PerformPurgeOutput' summary: 执行操作Purge tags: - dbinstance /dbinstances/{id}/reboot: post: description: 执行操作Reboot operationId: dbinstance_PerformReboot parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_PerformRebootOutput' summary: 执行操作Reboot tags: - dbinstance /dbinstances/{id}/recovery: post: description: 执行操作Recovery operationId: dbinstance_PerformRecovery parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance: $ref: '#/definitions/SDBInstanceRecoveryConfigInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_PerformRecoveryOutput' summary: 执行操作Recovery tags: - dbinstance /dbinstances/{id}/remote-update: post: description: 执行操作RemoteUpdate operationId: dbinstance_PerformRemoteUpdate parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance: $ref: '#/definitions/DBInstanceRemoteUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_PerformRemoteUpdateOutput' summary: 执行操作RemoteUpdate tags: - dbinstance /dbinstances/{id}/renew: post: description: 执行操作Renew operationId: dbinstance_PerformRenew parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_PerformRenewOutput' summary: 执行操作Renew tags: - dbinstance /dbinstances/{id}/set-auto-renew: post: description: |- 要求RDS状态为running 要求RDS计费类型为包年包月(预付费) operationId: dbinstance_PerformSetAutoRenew parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance: $ref: '#/definitions/DBInstanceAutoRenewInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_PerformSetAutoRenewOutput' summary: 设置自动续费 tags: - dbinstance /dbinstances/{id}/set-secgroup: post: description: 执行操作SetSecgroup operationId: dbinstance_PerformSetSecgroup parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dbinstance: $ref: '#/definitions/DBInstanceSetSecgroupInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dbinstance_PerformSetSecgroupOutput' summary: 执行操作SetSecgroup tags: - dbinstance /dbinstances/{id}/status: get: description: 获取指定信息Status operationId: dbinstance_GetDetailsStatus parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_GetDetailsStatusOutput' summary: 获取资源状态 tags: - dbinstance /dbinstances/{id}/sync: post: description: 执行操作Sync operationId: dbinstance_PerformSync parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_PerformSyncOutput' summary: 同步RDS信息 tags: - dbinstance /dbinstances/{id}/sync-status: post: description: 执行操作SyncStatus operationId: dbinstance_PerformSyncStatus parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_PerformSyncStatusOutput' summary: 同步RDS状态(弃用) tags: - dbinstance /dbinstances/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: dbinstance_PerformSyncstatus parameters: - description: The Id or Name of dbinstance in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dbinstance_PerformSyncstatusOutput' summary: 同步RDS实例状态 tags: - dbinstance /diskbackups: get: description: 列表 operationId: diskbackup_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/diskbackup_ListItemFilterOutput' summary: 列表 tags: - diskbackup post: description: 新建 operationId: diskbackup_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count diskbackup: $ref: '#/definitions/DiskBackupCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/diskbackup_ValidateCreateDataOutput' summary: 新建 tags: - diskbackup /diskbackups/{id}: delete: description: 删除 operationId: diskbackup_CustomizeDelete parameters: - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/diskbackup_CustomizeDeleteOutput' summary: 删除 tags: - diskbackup get: description: 获取详情 operationId: diskbackup_FetchCustomizeColumns parameters: - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/diskbackup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - diskbackup put: description: 更新 operationId: diskbackup_ValidateUpdateData parameters: - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: diskbackup: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/diskbackup_ValidateUpdateDataOutput' summary: 更新 tags: - diskbackup /diskbackups/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: diskbackup_PerformChangeOwner parameters: - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: diskbackup: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/diskbackup_PerformChangeOwnerOutput' summary: 更改项目 tags: - diskbackup /diskbackups/{id}/export-info: get: description: 获取指定信息ExportInfo operationId: diskbackup_GetDetailsExportInfo parameters: - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/diskbackup_GetDetailsExportInfoOutput' summary: 获取指定信息ExportInfo tags: - diskbackup /diskbackups/{id}/metadata: get: description: 获取指定信息Metadata operationId: diskbackup_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/diskbackup_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - diskbackup /diskbackups/{id}/recovery: post: description: 执行操作Recovery operationId: diskbackup_PerformRecovery parameters: - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: diskbackup: $ref: '#/definitions/DiskBackupRecoveryInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/diskbackup_PerformRecoveryOutput' summary: 执行操作Recovery tags: - diskbackup /diskbackups/{id}/status: get: description: 获取指定信息Status operationId: diskbackup_GetDetailsStatus parameters: - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/diskbackup_GetDetailsStatusOutput' summary: 获取资源状态 tags: - diskbackup /diskbackups/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: diskbackup_PerformSyncstatus parameters: - description: The Id or Name of diskbackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: diskbackup: $ref: '#/definitions/DiskBackupSyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/diskbackup_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - diskbackup /diskbackups/import: post: description: 执行操作Import operationId: diskbackup_PerformImport parameters: - in: body name: body schema: properties: diskbackup: $ref: '#/definitions/DiskBackupImportInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/diskbackup_PerformImportOutput' summary: 执行操作Import tags: - diskbackup /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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: 以host过滤 in: query name: storage_host_id type: string x-go-name: StorageHostId - 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 - 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 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 items: type: string name: server_id type: array 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 - 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 - description: 根据是否绑定快照策略过滤 in: query name: binding_snapshotpolicy type: boolean x-go-name: BindingSnapshotpolicy - description: 根据是否磁盘所在虚拟机是否绑定主机快照策略 in: query name: binding_server_snapshotpolicy type: boolean x-go-name: BindingServerSnapshotpolicy 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: |- 磁盘只能绑定一个快照策略，已绑定时报错 若磁盘所属主机已绑定主机快照策略，则磁盘不能再绑定快照策略 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: 绑定磁盘快照策略 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-billing-type: post: description: 执行操作ChangeBillingType operationId: disk_PerformChangeBillingType 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/DiskChangeBillingTypeInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/disk_PerformChangeBillingTypeOutput' summary: 执行操作ChangeBillingType 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-storage-type: post: description: 执行操作ChangeStorageType operationId: disk_PerformChangeStorageType 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/DiskChagneStorageTypeInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/disk_PerformChangeStorageTypeOutput' summary: 执行操作ChangeStorageType 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}/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}/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-snapshotpolicy: post: description: 可覆盖当前磁盘绑定的快照策略，若磁盘所属主机已绑定主机快照策略，则自动解除主机快照策略 operationId: disk_PerformSetSnapshotpolicy 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_PerformSetSnapshotpolicyOutput' 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 /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: 解绑自动快照策略 tags: - disk /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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/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}/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 /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/capability: get: description: 获取指定资源类的信息Capability operationId: dns_zone_GetPropertyCapability responses: "200": $ref: '#/responses/dns_zone_GetPropertyCapabilityOutput' summary: 获取指定资源类的信息Capability tags: - dns_zone /dnsrecords: get: description: 列表 operationId: dnsrecord_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/dnsrecord_ListItemFilterOutput' summary: DNS记录列表 tags: - dnsrecord post: description: 新建 operationId: dnsrecord_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count dnsrecord: $ref: '#/definitions/DnsRecordCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dnsrecord_ValidateCreateDataOutput' summary: 创建 tags: - dnsrecord /dnsrecords/{id}: delete: description: 删除 operationId: dnsrecord_CustomizeDelete parameters: - description: The Id or Name of dnsrecord in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dnsrecord_CustomizeDeleteOutput' summary: 删除 tags: - dnsrecord get: description: 获取详情 operationId: dnsrecord_FetchCustomizeColumns parameters: - description: The Id or Name of dnsrecord in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dnsrecord_FetchCustomizeColumnsOutput' summary: 解析详情 tags: - dnsrecord put: description: 更新 operationId: dnsrecord_ValidateUpdateData parameters: - description: The Id or Name of dnsrecord in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dnsrecord: $ref: '#/definitions/DnsRecordUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dnsrecord_ValidateUpdateDataOutput' summary: 更新 tags: - dnsrecord /dnsrecords/{id}/disable: post: description: 执行操作Disable operationId: dnsrecord_PerformDisable parameters: - description: The Id or Name of dnsrecord in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dnsrecord: $ref: '#/definitions/DnsRecordDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dnsrecord_PerformDisableOutput' summary: 禁用 tags: - dnsrecord /dnsrecords/{id}/enable: post: description: 执行操作Enable operationId: dnsrecord_PerformEnable parameters: - description: The Id or Name of dnsrecord in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: dnsrecord: $ref: '#/definitions/DnsRecordEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/dnsrecord_PerformEnableOutput' summary: 启用 tags: - dnsrecord /dnsrecords/{id}/metadata: get: description: 获取指定信息Metadata operationId: dnsrecord_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of dnsrecord in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dnsrecord_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - dnsrecord /dnsrecords/{id}/status: get: description: 获取指定信息Status operationId: dnsrecord_GetDetailsStatus parameters: - description: The Id or Name of dnsrecord in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/dnsrecord_GetDetailsStatusOutput' summary: 获取资源状态 tags: - dnsrecord /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以关联的调度标签（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}/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 /eips: get: description: 列表 operationId: eip_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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: 是否已关联资源 in: query name: is_associated type: boolean x-go-name: IsAssociated - description: IP地址 in: query items: type: string name: ip_addr type: array x-go-name: IpAddr - description: 绑定资源类型 in: query items: type: string name: associate_type type: array x-go-name: AssociateType - description: 绑定资源名称，模糊查询 in: query items: type: string name: associate_name type: array x-go-name: AssociateName - description: 绑定资源Id in: query items: type: string name: associate_id type: array 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/eip_ListItemFilterOutput' summary: 弹性公网IP列表 tags: - eip post: description: 新建 operationId: eip_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count eip: $ref: '#/definitions/SElasticipCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/eip_ValidateCreateDataOutput' summary: 新建 tags: - eip /eips/{id}: delete: description: 删除 operationId: eip_CustomizeDelete parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/eip_CustomizeDeleteOutput' summary: 删除 tags: - eip get: description: 获取详情 operationId: eip_FetchCustomizeColumns parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/eip_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - eip put: description: 更新 operationId: eip_ValidateUpdateData parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: eip: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/eip_ValidateUpdateDataOutput' summary: 更新 tags: - eip /eips/{id}/associate: post: description: 执行操作Associate operationId: eip_PerformAssociate parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: eip: $ref: '#/definitions/ElasticipAssociateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/eip_PerformAssociateOutput' summary: 执行操作Associate tags: - eip /eips/{id}/change-bandwidth: post: description: 执行操作ChangeBandwidth operationId: eip_PerformChangeBandwidth parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/eip_PerformChangeBandwidthOutput' summary: 执行操作ChangeBandwidth tags: - eip /eips/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: eip_PerformChangeOwner parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: eip: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/eip_PerformChangeOwnerOutput' summary: 更改项目 tags: - eip /eips/{id}/dissociate: post: description: 执行操作Dissociate operationId: eip_PerformDissociate parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: eip: $ref: '#/definitions/ElasticDissociateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/eip_PerformDissociateOutput' summary: 执行操作Dissociate tags: - eip /eips/{id}/metadata: get: description: 获取指定信息Metadata operationId: eip_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/eip_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - eip /eips/{id}/purge: post: description: 执行操作Purge operationId: eip_PerformPurge parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/eip_PerformPurgeOutput' summary: 执行操作Purge tags: - eip /eips/{id}/remote-update: post: description: 执行操作RemoteUpdate operationId: eip_PerformRemoteUpdate parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: eip: $ref: '#/definitions/ElasticipRemoteUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/eip_PerformRemoteUpdateOutput' summary: 执行操作RemoteUpdate tags: - eip /eips/{id}/status: get: description: 获取指定信息Status operationId: eip_GetDetailsStatus parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/eip_GetDetailsStatusOutput' summary: 获取资源状态 tags: - eip /eips/{id}/sync: post: description: 执行操作Sync operationId: eip_PerformSync parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/eip_PerformSyncOutput' summary: 执行操作Sync tags: - eip /eips/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: eip_PerformSyncstatus parameters: - description: The Id or Name of eip in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: eip: $ref: '#/definitions/ElasticipSyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/eip_PerformSyncstatusOutput' summary: 同步弹性公网IP状态 tags: - eip /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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 /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 /elasticcacheaccounts: get: description: 列表 operationId: elasticcacheaccount_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/elasticcacheaccount_ListItemFilterOutput' summary: 弹性缓存账号列表 tags: - elasticcacheaccount post: description: 新建 operationId: elasticcacheaccount_ValidateCreateData responses: "200": $ref: '#/responses/elasticcacheaccount_ValidateCreateDataOutput' summary: 新建 tags: - elasticcacheaccount /elasticcacheaccounts/{id}: delete: description: 删除 operationId: elasticcacheaccount_CustomizeDelete parameters: - description: The Id or Name of elasticcacheaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheaccount_CustomizeDeleteOutput' summary: 删除 tags: - elasticcacheaccount get: description: 获取详情 operationId: elasticcacheaccount_FetchCustomizeColumns parameters: - description: The Id or Name of elasticcacheaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheaccount_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - elasticcacheaccount put: description: 更新 operationId: elasticcacheaccount_ValidateUpdateData parameters: - description: The Id or Name of elasticcacheaccount in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: elasticcacheaccount: $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/elasticcacheaccount_ValidateUpdateDataOutput' summary: 更新 tags: - elasticcacheaccount /elasticcacheaccounts/{id}/login-info: get: description: 获取指定信息LoginInfo operationId: elasticcacheaccount_GetDetailsLoginInfo parameters: - description: The Id or Name of elasticcacheaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheaccount_GetDetailsLoginInfoOutput' summary: 获取指定信息LoginInfo tags: - elasticcacheaccount /elasticcacheaccounts/{id}/metadata: get: description: 获取指定信息Metadata operationId: elasticcacheaccount_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of elasticcacheaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheaccount_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - elasticcacheaccount /elasticcacheaccounts/{id}/reset-password: post: description: 执行操作ResetPassword operationId: elasticcacheaccount_PerformResetPassword parameters: - description: The Id or Name of elasticcacheaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheaccount_PerformResetPasswordOutput' summary: 执行操作ResetPassword tags: - elasticcacheaccount /elasticcacheaccounts/{id}/status: get: description: 获取指定信息Status operationId: elasticcacheaccount_GetDetailsStatus parameters: - description: The Id or Name of elasticcacheaccount in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheaccount_GetDetailsStatusOutput' summary: 获取资源状态 tags: - elasticcacheaccount /elasticcacheacls: get: description: 列表 operationId: elasticcacheacl_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源外部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 - 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/elasticcacheacl_ListItemFilterOutput' summary: 弹性缓存ACL规则列表 tags: - elasticcacheacl post: description: 新建 operationId: elasticcacheacl_ValidateCreateData responses: "200": $ref: '#/responses/elasticcacheacl_ValidateCreateDataOutput' summary: 新建 tags: - elasticcacheacl /elasticcacheacls/{id}: delete: description: 删除 operationId: elasticcacheacl_CustomizeDelete parameters: - description: The Id or Name of elasticcacheacl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheacl_CustomizeDeleteOutput' summary: 删除 tags: - elasticcacheacl get: description: 获取详情 operationId: elasticcacheacl_FetchCustomizeColumns parameters: - description: The Id or Name of elasticcacheacl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheacl_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - elasticcacheacl put: description: 更新 operationId: elasticcacheacl_ValidateUpdateData parameters: - description: The Id or Name of elasticcacheacl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheacl_ValidateUpdateDataOutput' summary: 更新 tags: - elasticcacheacl /elasticcacheacls/{id}/metadata: get: description: 获取指定信息Metadata operationId: elasticcacheacl_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of elasticcacheacl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheacl_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - elasticcacheacl /elasticcacheacls/{id}/status: get: description: 获取指定信息Status operationId: elasticcacheacl_GetDetailsStatus parameters: - description: The Id or Name of elasticcacheacl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheacl_GetDetailsStatusOutput' summary: 获取资源状态 tags: - elasticcacheacl /elasticcachebackups: get: description: 列表 operationId: elasticcachebackup_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/elasticcachebackup_ListItemFilterOutput' summary: 弹性缓存备份列表 tags: - elasticcachebackup post: description: 新建 operationId: elasticcachebackup_ValidateCreateData responses: "200": $ref: '#/responses/elasticcachebackup_ValidateCreateDataOutput' summary: 新建 tags: - elasticcachebackup /elasticcachebackups/{id}: delete: description: 删除 operationId: elasticcachebackup_CustomizeDelete parameters: - description: The Id or Name of elasticcachebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachebackup_CustomizeDeleteOutput' summary: 删除 tags: - elasticcachebackup get: description: 获取详情 operationId: elasticcachebackup_FetchCustomizeColumns parameters: - description: The Id or Name of elasticcachebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachebackup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - elasticcachebackup put: description: 更新 operationId: elasticcachebackup_ValidateUpdateData parameters: - description: The Id or Name of elasticcachebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: elasticcachebackup: $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/elasticcachebackup_ValidateUpdateDataOutput' summary: 更新 tags: - elasticcachebackup /elasticcachebackups/{id}/metadata: get: description: 获取指定信息Metadata operationId: elasticcachebackup_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of elasticcachebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachebackup_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - elasticcachebackup /elasticcachebackups/{id}/restore-instance: post: description: 执行操作RestoreInstance operationId: elasticcachebackup_PerformRestoreInstance parameters: - description: The Id or Name of elasticcachebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachebackup_PerformRestoreInstanceOutput' summary: 执行操作RestoreInstance tags: - elasticcachebackup /elasticcachebackups/{id}/status: get: description: 获取指定信息Status operationId: elasticcachebackup_GetDetailsStatus parameters: - description: The Id or Name of elasticcachebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachebackup_GetDetailsStatusOutput' summary: 获取资源状态 tags: - elasticcachebackup /elasticcacheparameters: get: description: 列表 operationId: elasticcacheparameter_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源外部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 - 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/elasticcacheparameter_ListItemFilterOutput' summary: 列出弹性缓存参数 tags: - elasticcacheparameter post: description: 新建 operationId: elasticcacheparameter_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count elasticcacheparameter: $ref: '#/definitions/StandaloneResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/elasticcacheparameter_ValidateCreateDataOutput' summary: 新建 tags: - elasticcacheparameter /elasticcacheparameters/{id}: delete: description: 删除 operationId: elasticcacheparameter_CustomizeDelete parameters: - description: The Id or Name of elasticcacheparameter in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheparameter_CustomizeDeleteOutput' summary: 删除 tags: - elasticcacheparameter get: description: 获取详情 operationId: elasticcacheparameter_FetchCustomizeColumns parameters: - description: The Id or Name of elasticcacheparameter in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheparameter_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - elasticcacheparameter put: description: 更新 operationId: elasticcacheparameter_ValidateUpdateData parameters: - description: The Id or Name of elasticcacheparameter in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheparameter_ValidateUpdateDataOutput' summary: 更新 tags: - elasticcacheparameter /elasticcacheparameters/{id}/metadata: get: description: 获取指定信息Metadata operationId: elasticcacheparameter_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of elasticcacheparameter in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheparameter_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - elasticcacheparameter /elasticcacheparameters/{id}/status: get: description: 获取指定信息Status operationId: elasticcacheparameter_GetDetailsStatus parameters: - description: The Id or Name of elasticcacheparameter in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcacheparameter_GetDetailsStatusOutput' summary: 获取资源状态 tags: - elasticcacheparameter /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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-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: 更改项目 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}/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}/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-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}/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 /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}/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 /elasticcacheskus: get: description: 列表 operationId: elasticcachesku_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/elasticcachesku_ListItemFilterOutput' summary: 弹性缓存套餐规格列表 tags: - elasticcachesku post: description: 新建 operationId: elasticcachesku_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count elasticcachesku: $ref: '#/definitions/StatusStandaloneResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/elasticcachesku_ValidateCreateDataOutput' summary: 新建 tags: - elasticcachesku /elasticcacheskus/{id}: delete: description: 删除 operationId: elasticcachesku_CustomizeDelete parameters: - description: The Id or Name of elasticcachesku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachesku_CustomizeDeleteOutput' summary: 删除 tags: - elasticcachesku get: description: 获取详情 operationId: elasticcachesku_FetchCustomizeColumns parameters: - description: The Id or Name of elasticcachesku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachesku_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - elasticcachesku put: description: 更新 operationId: elasticcachesku_ValidateUpdateData parameters: - description: The Id or Name of elasticcachesku in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: elasticcachesku: $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/elasticcachesku_ValidateUpdateDataOutput' summary: 更新 tags: - elasticcachesku /elasticcacheskus/{id}/metadata: get: description: 获取指定信息Metadata operationId: elasticcachesku_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of elasticcachesku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachesku_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - elasticcachesku /elasticcacheskus/{id}/status: get: description: 获取指定信息Status operationId: elasticcachesku_GetDetailsStatus parameters: - description: The Id or Name of elasticcachesku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/elasticcachesku_GetDetailsStatusOutput' summary: 获取资源状态 tags: - elasticcachesku /elasticcacheskus/capability: get: description: 获取指定资源类的信息Capability operationId: elasticcachesku_GetPropertyCapability responses: "200": $ref: '#/responses/elasticcachesku_GetPropertyCapabilityOutput' summary: 获取指定资源类的信息Capability tags: - elasticcachesku /elasticcacheskus/instance-specs: get: description: 获取指定资源类的信息InstanceSpecs operationId: elasticcachesku_GetPropertyInstanceSpecs responses: "200": $ref: '#/responses/elasticcachesku_GetPropertyInstanceSpecsOutput' summary: 获取指定资源类的信息InstanceSpecs tags: - elasticcachesku /elasticcacheskus/sync-skus: post: description: 执行操作SyncSkus operationId: elasticcachesku_PerformSyncSkus parameters: - in: body name: body schema: properties: elasticcachesku: $ref: '#/definitions/SkuSyncInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/elasticcachesku_PerformSyncSkusOutput' summary: 执行操作SyncSkus tags: - elasticcachesku /elasticcacheskus/sync-tasks: get: description: 获取指定资源类的信息SyncTasks operationId: elasticcachesku_GetPropertySyncTasks parameters: - description: 异步任务ID in: query items: type: string name: task_ids type: array x-go-name: TaskIds responses: "200": $ref: '#/responses/elasticcachesku_GetPropertySyncTasksOutput' summary: 获取指定资源类的信息SyncTasks tags: - elasticcachesku /externalprojects: get: description: 列表 operationId: externalproject_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/externalproject_ListItemFilterOutput' summary: 云平台导入项目列表 tags: - externalproject post: description: 新建 operationId: externalproject_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count externalproject: $ref: '#/definitions/ExternalProjectCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/externalproject_ValidateCreateDataOutput' summary: 新建 tags: - externalproject /externalprojects/{id}: delete: description: 删除 operationId: externalproject_CustomizeDelete parameters: - description: The Id or Name of externalproject in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/externalproject_CustomizeDeleteOutput' summary: 删除 tags: - externalproject get: description: 获取详情 operationId: externalproject_FetchCustomizeColumns parameters: - description: The Id or Name of externalproject in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/externalproject_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - externalproject put: description: 更新 operationId: externalproject_ValidateUpdateData parameters: - description: The Id or Name of externalproject in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: externalproject: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/externalproject_ValidateUpdateDataOutput' summary: 更新 tags: - externalproject /externalprojects/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: externalproject_PerformChangeOwner parameters: - description: The Id or Name of externalproject in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: externalproject: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/externalproject_PerformChangeOwnerOutput' summary: 更改项目 tags: - externalproject /externalprojects/{id}/change-project: post: description: 执行操作ChangeProject operationId: externalproject_PerformChangeProject parameters: - description: The Id or Name of externalproject in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: externalproject: $ref: '#/definitions/ExternalProjectChangeProjectInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/externalproject_PerformChangeProjectOutput' summary: 切换本地项目 tags: - externalproject /externalprojects/{id}/metadata: get: description: 获取指定信息Metadata operationId: externalproject_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of externalproject in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/externalproject_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - externalproject /externalprojects/{id}/status: get: description: 获取指定信息Status operationId: externalproject_GetDetailsStatus parameters: - description: The Id or Name of externalproject in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/externalproject_GetDetailsStatusOutput' summary: 获取资源状态 tags: - externalproject /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/SharableVirtualResourceBaseUpdateInput' 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/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/file_system_PerformChangeOwnerOutput' summary: 更改项目 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/PerformPublicProjectInput' 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-quota: post: description: 执行操作SetQuota operationId: file_system_PerformSetQuota 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/FileSystemSetQuotaInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/file_system_PerformSetQuotaOutput' summary: 设置容量大小(CephFS) 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 /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 /globalvpcs: get: description: 列表 operationId: globalvpc_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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/globalvpc_ListItemFilterOutput' summary: 全局VPC列表 tags: - globalvpc post: description: 新建 operationId: globalvpc_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count globalvpc: $ref: '#/definitions/GlobalVpcCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/globalvpc_ValidateCreateDataOutput' summary: 新建 tags: - globalvpc /globalvpcs/{id}: delete: description: 删除 operationId: globalvpc_CustomizeDelete parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/globalvpc_CustomizeDeleteOutput' summary: 删除 tags: - globalvpc get: description: 获取详情 operationId: globalvpc_FetchCustomizeColumns parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/globalvpc_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - globalvpc put: description: 更新 operationId: globalvpc_ValidateUpdateData parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: globalvpc: $ref: '#/definitions/GlobalvpcUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/globalvpc_ValidateUpdateDataOutput' summary: 更新 tags: - globalvpc /globalvpcs/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: globalvpc_PerformChangeOwner parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: globalvpc: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/globalvpc_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - globalvpc /globalvpcs/{id}/disable: post: description: 执行操作Disable operationId: globalvpc_PerformDisable parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: globalvpc: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/globalvpc_PerformDisableOutput' summary: 禁用资源 tags: - globalvpc /globalvpcs/{id}/enable: post: description: 执行操作Enable operationId: globalvpc_PerformEnable parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: globalvpc: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/globalvpc_PerformEnableOutput' summary: 启用资源 tags: - globalvpc /globalvpcs/{id}/metadata: get: description: 获取指定信息Metadata operationId: globalvpc_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/globalvpc_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - globalvpc /globalvpcs/{id}/private: post: description: 执行操作Private operationId: globalvpc_PerformPrivate parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: globalvpc: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/globalvpc_PerformPrivateOutput' summary: 执行操作Private tags: - globalvpc /globalvpcs/{id}/public: post: description: 执行操作Public operationId: globalvpc_PerformPublic parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: globalvpc: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/globalvpc_PerformPublicOutput' summary: 执行操作Public tags: - globalvpc /globalvpcs/{id}/status: get: description: 获取指定信息Status operationId: globalvpc_GetDetailsStatus parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/globalvpc_GetDetailsStatusOutput' summary: 获取资源状态 tags: - globalvpc /globalvpcs/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: globalvpc_PerformSyncstatus parameters: - description: The Id or Name of globalvpc in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: globalvpc: $ref: '#/definitions/SyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/globalvpc_PerformSyncstatusOutput' summary: 同步全局VPC状态 tags: - globalvpc /guest_network_traffic_logs: get: description: 列表 operationId: guest_network_traffic_log_ListItemFilter parameters: - 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或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 - 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 - format: date-time in: query name: since type: string x-go-name: Since - format: date-time in: query name: until type: string x-go-name: Until - 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: $ref: '#/definitions/GuestNetworkTrafficState' name: state type: array x-go-name: State responses: "200": $ref: '#/responses/guest_network_traffic_log_ListItemFilterOutput' summary: 操作日志列表 tags: - guest_network_traffic_log post: description: 新建 operationId: guest_network_traffic_log_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count guest_network_traffic_log: $ref: '#/definitions/ModelBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/guest_network_traffic_log_ValidateCreateDataOutput' summary: 新建 tags: - guest_network_traffic_log /guest_network_traffic_logs/{id}: delete: description: 删除 operationId: guest_network_traffic_log_CustomizeDelete parameters: - description: The Id or Name of guest_network_traffic_log in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/guest_network_traffic_log_CustomizeDeleteOutput' summary: 删除 tags: - guest_network_traffic_log get: description: 获取详情 operationId: guest_network_traffic_log_FetchCustomizeColumns parameters: - description: The Id or Name of guest_network_traffic_log in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/guest_network_traffic_log_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - guest_network_traffic_log put: description: 更新 operationId: guest_network_traffic_log_ValidateUpdateData parameters: - description: The Id or Name of guest_network_traffic_log in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/guest_network_traffic_log_ValidateUpdateDataOutput' summary: 更新 tags: - guest_network_traffic_log /guest_screen_dumps: get: description: 列表 operationId: guest_screen_dump_ListItemFilter parameters: - in: query name: server type: string x-go-name: Server responses: "200": $ref: '#/responses/guest_screen_dump_ListItemFilterOutput' summary: 列表 tags: - guest_screen_dump post: description: 新建 operationId: guest_screen_dump_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count guest_screen_dump: $ref: '#/definitions/ResourceBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/guest_screen_dump_ValidateCreateDataOutput' summary: 新建 tags: - guest_screen_dump /guest_screen_dumps/{id}: delete: description: 删除 operationId: guest_screen_dump_CustomizeDelete parameters: - description: The Id or Name of guest_screen_dump in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/guest_screen_dump_CustomizeDeleteOutput' summary: 删除 tags: - guest_screen_dump get: description: 获取详情 operationId: guest_screen_dump_FetchCustomizeColumns parameters: - description: The Id or Name of guest_screen_dump in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/guest_screen_dump_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - guest_screen_dump put: description: 更新 operationId: guest_screen_dump_ValidateUpdateData parameters: - description: The Id or Name of guest_screen_dump in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: guest_screen_dump: $ref: '#/definitions/ResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/guest_screen_dump_ValidateUpdateDataOutput' summary: 更新 tags: - guest_screen_dump /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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 /guestnetworksecgroups: get: description: 列表 operationId: guestnetworksecgroup_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - 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 - 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: 区域名称或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 - 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_secgroup type: string x-go-name: OrderBySecgroup - format: int64 in: query name: network_index type: integer x-go-name: NetworkIndex - in: query name: is_admin type: boolean x-go-name: IsAdmin responses: "200": $ref: '#/responses/guestnetworksecgroup_ListItemFilterOutput' summary: 列表 tags: - guestnetworksecgroup post: description: 新建 operationId: guestnetworksecgroup_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count guestnetworksecgroup: $ref: '#/definitions/ResourceBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/guestnetworksecgroup_ValidateCreateDataOutput' summary: 新建 tags: - guestnetworksecgroup /guestnetworksecgroups/{id}: delete: description: 删除 operationId: guestnetworksecgroup_CustomizeDelete parameters: - description: The Id or Name of guestnetworksecgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/guestnetworksecgroup_CustomizeDeleteOutput' summary: 删除 tags: - guestnetworksecgroup get: description: 获取详情 operationId: guestnetworksecgroup_FetchCustomizeColumns parameters: - description: The Id or Name of guestnetworksecgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/guestnetworksecgroup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - guestnetworksecgroup put: description: 更新 operationId: guestnetworksecgroup_ValidateUpdateData parameters: - description: The Id or Name of guestnetworksecgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: guestnetworksecgroup: $ref: '#/definitions/ResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/guestnetworksecgroup_ValidateUpdateDataOutput' summary: 更新 tags: - guestnetworksecgroup /host_dmesg_logs: get: description: 列表 operationId: host_dmesg_log_ListItemFilter parameters: - in: query items: type: string name: owner_project_ids type: array x-go-name: OwnerProjectIds - in: query items: type: string name: owner_domain_ids type: array x-go-name: OwnerDomainIds - description: filter by obj type in: query items: type: string name: obj_type type: array x-go-name: ObjTypes - description: filter by obj name or obj id in: query items: type: string name: obj type: array x-go-name: Objs - description: filter by obj ids in: query items: type: string name: obj_id type: array x-go-name: ObjIds - description: filter by obj name in: query items: type: string name: obj_name type: array x-go-name: ObjNames - description: filter by action in: query items: type: string name: action type: array x-go-name: Actions - format: date-time in: query name: since type: string x-go-name: Since - format: date-time in: query name: until type: string x-go-name: Until - in: query items: type: string name: log_levels type: array x-go-name: LogLevels - in: query name: show_dmesg_log type: boolean x-go-name: ShowDmesgLog responses: "200": $ref: '#/responses/host_dmesg_log_ListItemFilterOutput' summary: 列表 tags: - host_dmesg_log post: description: 新建 operationId: host_dmesg_log_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count host_dmesg_log: $ref: '#/definitions/OpsLogCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_dmesg_log_ValidateCreateDataOutput' summary: 新建 tags: - host_dmesg_log /host_dmesg_logs/{id}: delete: description: 删除 operationId: host_dmesg_log_CustomizeDelete parameters: - description: The Id or Name of host_dmesg_log in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/host_dmesg_log_CustomizeDeleteOutput' summary: 删除 tags: - host_dmesg_log get: description: 获取详情 operationId: host_dmesg_log_FetchCustomizeColumns parameters: - description: The Id or Name of host_dmesg_log in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/host_dmesg_log_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - host_dmesg_log put: description: 更新 operationId: host_dmesg_log_ValidateUpdateData parameters: - description: The Id or Name of host_dmesg_log in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/host_dmesg_log_ValidateUpdateDataOutput' summary: 更新 tags: - host_dmesg_log /host_files: get: description: 列表 operationId: host_file_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 指定项目归属域名称或ID in: query name: project_domain_id type: string x-go-name: ProjectDomainId - description: 对具有域属性的资源，严格匹配域ID in: query items: type: string name: project_domain_ids type: array x-go-name: ProjectDomainIds - description: 按domain名称排序，可能值为asc|desc in: query name: order_by_domain pattern: asc|desc type: string x-go-name: OrderByDomain - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: domain_tags x-go-name: DomainTags - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: no_domain_tags x-go-name: NoDomainTags - description: 以资源是否共享过滤列表 in: query name: is_public type: boolean x-go-name: IsPublic - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project in: query name: public_scope type: string x-go-name: PublicScope - in: query items: type: string name: type type: array x-go-name: Type - in: query name: path type: string x-go-name: Path responses: "200": $ref: '#/responses/host_file_ListItemFilterOutput' summary: 列表 tags: - host_file post: description: 新建 operationId: host_file_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count host_file: $ref: '#/definitions/HostFileCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_file_ValidateCreateDataOutput' summary: 新建 tags: - host_file /host_files/{id}: delete: description: 删除 operationId: host_file_CustomizeDelete parameters: - description: The Id or Name of host_file in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/host_file_CustomizeDeleteOutput' summary: 删除 tags: - host_file get: description: 获取详情 operationId: host_file_FetchCustomizeColumns parameters: - description: The Id or Name of host_file in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/host_file_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - host_file put: description: 更新 operationId: host_file_ValidateUpdateData parameters: - description: The Id or Name of host_file in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: host_file: $ref: '#/definitions/InfrasResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_file_ValidateUpdateDataOutput' summary: 更新 tags: - host_file /host_files/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: host_file_PerformChangeOwner parameters: - description: The Id or Name of host_file in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: host_file: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_file_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - host_file /host_files/{id}/metadata: get: description: 获取指定信息Metadata operationId: host_file_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: 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_file in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/host_file_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - host_file /host_files/{id}/private: post: description: 执行操作Private operationId: host_file_PerformPrivate parameters: - description: The Id or Name of host_file in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: host_file: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_file_PerformPrivateOutput' summary: 执行操作Private tags: - host_file /host_files/{id}/public: post: description: 执行操作Public operationId: host_file_PerformPublic parameters: - description: The Id or Name of host_file in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: host_file: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_file_PerformPublicOutput' summary: 执行操作Public tags: - host_file /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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: 以host过滤 in: query name: storage_host_id type: string x-go-name: StorageHostId - 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 - 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: 公网IP地址 in: query items: type: string name: public_ip type: array x-go-name: PublicIp - 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 - description: |- 按本地存储分配大小排序 enmu: asc,desc in: query name: order_by_storage_used type: string x-go-name: OrderByStorageUsed - description: |- 按cpu分配大小排序 enmu: asc,desc in: query name: order_by_cpu_commit type: string x-go-name: OrderByCpuCommit - description: |- 按内存分配大小排序 enmu: asc,desc in: query name: order_by_mem_commit type: string x-go-name: OrderByMemCommit - description: |- 按物理cpu使用率排序 enmu: asc,desc in: query name: order_by_cpu_usage type: string x-go-name: OrderByCpuUsage - description: |- 按物理内存使用率排序 enmu: asc,desc in: query name: order_by_mem_usage type: string x-go-name: OrderByMemUsage - description: |- 按物理存储使用率排序 enmu: asc,desc in: query name: order_by_storage_usage type: string x-go-name: OrderByStorageUsage - description: |- 按虚拟内存使用率排序 enmu: asc,desc in: query name: order_by_virtual_mem_usage type: string x-go-name: OrderByVirtualMemUsage - description: |- 按虚拟cpu使用率排序 enmu: asc,desc in: query name: order_by_virtual_cpu_usage type: string x-go-name: OrderByVirtualCpuUsage - description: |- 按虚拟存储使用率排序 enmu: asc,desc in: query name: order_by_virtual_storage_usage type: string x-go-name: OrderByVirtualStorageUsage 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}/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-files: get: description: 获取指定信息HostFiles operationId: host_GetDetailsHostFiles 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_GetDetailsHostFilesOutput' summary: 获取指定信息HostFiles 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}/isolated-device-numa-stats: get: description: 获取指定信息IsolatedDeviceNumaStats operationId: host_GetDetailsIsolatedDeviceNumaStats parameters: - in: query name: dev_type type: string x-go-name: DevType - description: The Id or Name of host in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/host_GetDetailsIsolatedDeviceNumaStatsOutput' summary: 获取指定信息IsolatedDeviceNumaStats 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}/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}/report-dmesg: post: description: 执行操作ReportDmesg operationId: host_PerformReportDmesg 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/SHostReportDmesgInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_PerformReportDmesgOutput' summary: 执行操作ReportDmesg 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-commit-bound: post: description: 执行操作SetCommitBound operationId: host_PerformSetCommitBound 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/HostSetCommitBoundInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_PerformSetCommitBoundOutput' summary: 执行操作SetCommitBound tags: - host /hosts/{id}/set-host-files: post: description: 执行操作SetHostFiles operationId: host_PerformSetHostFiles 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/HostSetHostFilesInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_PerformSetHostFilesOutput' summary: 执行操作SetHostFiles 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}/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 - in: body name: body schema: properties: host: $ref: '#/definitions/GuestNicTrafficSyncInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_PerformSyncGuestNicTrafficsOutput' summary: 执行操作SyncGuestNicTraffics tags: - host /hosts/{id}/sync-isolated-devices: post: description: 执行操作SyncIsolatedDevices operationId: host_PerformSyncIsolatedDevices 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_PerformSyncIsolatedDevicesOutput' summary: 执行操作SyncIsolatedDevices 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/{id}/worker-stats: get: description: 获取指定信息WorkerStats operationId: host_GetDetailsWorkerStats 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_GetDetailsWorkerStatsOutput' summary: 获取指定信息WorkerStats tags: - host /hosts/bm-start-register-script: get: description: 获取指定资源类的信息BmStartRegisterScript operationId: host_GetPropertyBmStartRegisterScript responses: "200": $ref: '#/responses/host_GetPropertyBmStartRegisterScriptOutput' summary: 获取指定资源类的信息BmStartRegisterScript 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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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: 以host过滤 in: query name: storage_host_id type: string x-go-name: StorageHostId - 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 - 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: 公网IP地址 in: query items: type: string name: public_ip type: array x-go-name: PublicIp - 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 - description: |- 按本地存储分配大小排序 enmu: asc,desc in: query name: order_by_storage_used type: string x-go-name: OrderByStorageUsed - description: |- 按cpu分配大小排序 enmu: asc,desc in: query name: order_by_cpu_commit type: string x-go-name: OrderByCpuCommit - description: |- 按内存分配大小排序 enmu: asc,desc in: query name: order_by_mem_commit type: string x-go-name: OrderByMemCommit - description: |- 按物理cpu使用率排序 enmu: asc,desc in: query name: order_by_cpu_usage type: string x-go-name: OrderByCpuUsage - description: |- 按物理内存使用率排序 enmu: asc,desc in: query name: order_by_mem_usage type: string x-go-name: OrderByMemUsage - description: |- 按物理存储使用率排序 enmu: asc,desc in: query name: order_by_storage_usage type: string x-go-name: OrderByStorageUsage - description: |- 按虚拟内存使用率排序 enmu: asc,desc in: query name: order_by_virtual_mem_usage type: string x-go-name: OrderByVirtualMemUsage - description: |- 按虚拟cpu使用率排序 enmu: asc,desc in: query name: order_by_virtual_cpu_usage type: string x-go-name: OrderByVirtualCpuUsage - description: |- 按虚拟存储使用率排序 enmu: asc,desc in: query name: order_by_virtual_storage_usage type: string x-go-name: OrderByVirtualStorageUsage 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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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: 以host过滤 in: query name: storage_host_id type: string x-go-name: StorageHostId - 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 - 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: 公网IP地址 in: query items: type: string name: public_ip type: array x-go-name: PublicIp - 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 - description: |- 按本地存储分配大小排序 enmu: asc,desc in: query name: order_by_storage_used type: string x-go-name: OrderByStorageUsed - description: |- 按cpu分配大小排序 enmu: asc,desc in: query name: order_by_cpu_commit type: string x-go-name: OrderByCpuCommit - description: |- 按内存分配大小排序 enmu: asc,desc in: query name: order_by_mem_commit type: string x-go-name: OrderByMemCommit - description: |- 按物理cpu使用率排序 enmu: asc,desc in: query name: order_by_cpu_usage type: string x-go-name: OrderByCpuUsage - description: |- 按物理内存使用率排序 enmu: asc,desc in: query name: order_by_mem_usage type: string x-go-name: OrderByMemUsage - description: |- 按物理存储使用率排序 enmu: asc,desc in: query name: order_by_storage_usage type: string x-go-name: OrderByStorageUsage - description: |- 按虚拟内存使用率排序 enmu: asc,desc in: query name: order_by_virtual_mem_usage type: string x-go-name: OrderByVirtualMemUsage - description: |- 按虚拟cpu使用率排序 enmu: asc,desc in: query name: order_by_virtual_cpu_usage type: string x-go-name: OrderByVirtualCpuUsage - description: |- 按虚拟存储使用率排序 enmu: asc,desc in: query name: order_by_virtual_storage_usage type: string x-go-name: OrderByVirtualStorageUsage responses: "200": $ref: '#/responses/host_GetPropertyNodeCountOutput' summary: 获取指定资源类的信息NodeCount tags: - host /hosts/validate-ipmi: post: description: 执行操作ValidateIpmi operationId: host_PerformValidateIpmi parameters: - in: body name: body schema: properties: host: $ref: '#/definitions/ValidateIPMIRequest' type: object x-go-name: Body responses: "200": $ref: '#/responses/host_PerformValidateIpmiOutput' summary: 执行操作ValidateIpmi tags: - host /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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/purge: post: description: 执行操作Purge operationId: instance_snapshot_PerformPurge 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_PerformPurgeOutput' summary: 执行操作Purge 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 /instancebackups: get: description: 列表 operationId: instancebackup_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/instancebackup_ListItemFilterOutput' summary: 列表 tags: - instancebackup post: description: 新建 operationId: instancebackup_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count instancebackup: $ref: '#/definitions/InstanceBackupManagerCreateFromPackageInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancebackup_ValidateCreateDataOutput' summary: 新建 tags: - instancebackup /instancebackups/{id}: delete: description: 删除 operationId: instancebackup_CustomizeDelete parameters: - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancebackup_CustomizeDeleteOutput' summary: 删除 tags: - instancebackup get: description: 获取详情 operationId: instancebackup_FetchCustomizeColumns parameters: - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancebackup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - instancebackup put: description: 更新 operationId: instancebackup_ValidateUpdateData parameters: - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancebackup: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancebackup_ValidateUpdateDataOutput' summary: 更新 tags: - instancebackup /instancebackups/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: instancebackup_PerformChangeOwner parameters: - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancebackup: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancebackup_PerformChangeOwnerOutput' summary: 更改项目 tags: - instancebackup /instancebackups/{id}/metadata: get: description: 获取指定信息Metadata operationId: instancebackup_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancebackup_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - instancebackup /instancebackups/{id}/pack: post: description: 执行操作Pack operationId: instancebackup_PerformPack parameters: - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancebackup: $ref: '#/definitions/InstanceBackupPackInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancebackup_PerformPackOutput' summary: 执行操作Pack tags: - instancebackup /instancebackups/{id}/recovery: post: description: 执行操作Recovery operationId: instancebackup_PerformRecovery parameters: - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancebackup: $ref: '#/definitions/InstanceBackupRecoveryInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancebackup_PerformRecoveryOutput' summary: 执行操作Recovery tags: - instancebackup /instancebackups/{id}/status: get: description: 获取指定信息Status operationId: instancebackup_GetDetailsStatus parameters: - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancebackup_GetDetailsStatusOutput' summary: 获取资源状态 tags: - instancebackup /instancebackups/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: instancebackup_PerformSyncstatus parameters: - description: The Id or Name of instancebackup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancebackup: $ref: '#/definitions/InstanceBackupManagerSyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancebackup_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - instancebackup /instancegroups: get: description: 列表 operationId: instancegroup_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/instancegroup_ListItemFilterOutput' summary: 主机组列表 tags: - instancegroup post: description: 新建 operationId: instancegroup_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count instancegroup: $ref: '#/definitions/VirtualResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_ValidateCreateDataOutput' summary: 新建 tags: - instancegroup /instancegroups/{id}: delete: description: 删除 operationId: instancegroup_CustomizeDelete parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancegroup_CustomizeDeleteOutput' summary: 删除 tags: - instancegroup get: description: 获取详情 operationId: instancegroup_FetchCustomizeColumns parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancegroup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - instancegroup put: description: 更新 operationId: instancegroup_ValidateUpdateData parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_ValidateUpdateDataOutput' summary: 更新 tags: - instancegroup /instancegroups/{id}/associate-eip: post: description: 执行操作AssociateEip operationId: instancegroup_PerformAssociateEip parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/ServerAssociateEipInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_PerformAssociateEipOutput' summary: 执行操作AssociateEip tags: - instancegroup /instancegroups/{id}/attachnetwork: post: description: 执行操作Attachnetwork operationId: instancegroup_PerformAttachnetwork parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/GroupAttachNetworkInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_PerformAttachnetworkOutput' summary: 执行操作Attachnetwork tags: - instancegroup /instancegroups/{id}/bind-guests: post: description: 执行操作BindGuests operationId: instancegroup_PerformBindGuests parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancegroup_PerformBindGuestsOutput' summary: 执行操作BindGuests tags: - instancegroup /instancegroups/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: instancegroup_PerformChangeOwner parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_PerformChangeOwnerOutput' summary: 更改项目 tags: - instancegroup /instancegroups/{id}/create-eip: post: description: 执行操作CreateEip operationId: instancegroup_PerformCreateEip parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/ServerCreateEipInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_PerformCreateEipOutput' summary: 执行操作CreateEip tags: - instancegroup /instancegroups/{id}/detachnetwork: post: description: 执行操作Detachnetwork operationId: instancegroup_PerformDetachnetwork parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/GroupDetachNetworkInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_PerformDetachnetworkOutput' summary: 执行操作Detachnetwork tags: - instancegroup /instancegroups/{id}/disable: post: description: 执行操作Disable operationId: instancegroup_PerformDisable parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_PerformDisableOutput' summary: 执行操作Disable tags: - instancegroup /instancegroups/{id}/dissociate-eip: post: description: 执行操作DissociateEip operationId: instancegroup_PerformDissociateEip parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/ServerDissociateEipInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_PerformDissociateEipOutput' summary: 执行操作DissociateEip tags: - instancegroup /instancegroups/{id}/enable: post: description: 执行操作Enable operationId: instancegroup_PerformEnable parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: instancegroup: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/instancegroup_PerformEnableOutput' summary: 执行操作Enable tags: - instancegroup /instancegroups/{id}/metadata: get: description: 获取指定信息Metadata operationId: instancegroup_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancegroup_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - instancegroup /instancegroups/{id}/status: get: description: 获取指定信息Status operationId: instancegroup_GetDetailsStatus parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancegroup_GetDetailsStatusOutput' summary: 获取资源状态 tags: - instancegroup /instancegroups/{id}/unbind-guests: post: description: 执行操作UnbindGuests operationId: instancegroup_PerformUnbindGuests parameters: - description: The Id or Name of instancegroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/instancegroup_PerformUnbindGuestsOutput' summary: 执行操作UnbindGuests tags: - instancegroup /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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: inter_vpc_network_id type: string x-go-name: InterVpcNetworkId - 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats 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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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}/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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 设备类型 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}/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}/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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源外部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: 可用区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 - 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: 设备路径 in: query items: type: string name: device_path type: array x-go-name: DevicePath - description: 设备VENDOE编号 in: query items: type: string name: vendor_device_id type: array x-go-name: VendorDeviceId - description: NUMA节点序号 in: query items: format: uint8 type: integer name: numa_node type: array x-go-name: NumaNode - 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 - description: GPU index format: int64 in: query name: index type: integer x-go-name: Index - description: Nvidia GPU minor number, parsing from /proc/driver/nvidia/gpus/*/information format: int64 in: query name: device_minor type: integer x-go-name: DeviceMinor 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}/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}/private: post: description: 执行操作Private operationId: isolated_device_PerformPrivate 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/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/isolated_device_PerformPrivateOutput' summary: 执行操作Private tags: - isolated_device /isolated_devices/{id}/public: post: description: 执行操作Public operationId: isolated_device_PerformPublic 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/PerformPublicProjectInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/isolated_device_PerformPublicOutput' summary: 执行操作Public 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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 查询指定的用户（ID或名称）拥有的资源 in: query name: 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats 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 /loadbalanceracls: get: description: 列表 operationId: loadbalanceracl_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/loadbalanceracl_ListItemFilterOutput' summary: 负载均衡ACL规则列表 tags: - loadbalanceracl post: description: 新建 operationId: loadbalanceracl_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count loadbalanceracl: $ref: '#/definitions/LoadbalancerAclCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceracl_ValidateCreateDataOutput' summary: 新建 tags: - loadbalanceracl /loadbalanceracls/{id}: delete: description: 删除 operationId: loadbalanceracl_CustomizeDelete parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceracl_CustomizeDeleteOutput' summary: 删除 tags: - loadbalanceracl get: description: 获取详情 operationId: loadbalanceracl_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceracl_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalanceracl put: description: 更新 operationId: loadbalanceracl_ValidateUpdateData parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalanceracl: $ref: '#/definitions/LoadbalancerAclUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceracl_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalanceracl /loadbalanceracls/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: loadbalanceracl_PerformChangeOwner parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalanceracl: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceracl_PerformChangeOwnerOutput' summary: 更改项目 tags: - loadbalanceracl /loadbalanceracls/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalanceracl_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceracl_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalanceracl /loadbalanceracls/{id}/patch: post: description: This is intended mainly for command line operations. operationId: loadbalanceracl_PerformPatch parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalanceracl: $ref: '#/definitions/LoadbalancerAclPatchInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceracl_PerformPatchOutput' summary: PerformPatch patches acl entries by adding then deleting the specified acls. tags: - loadbalanceracl /loadbalanceracls/{id}/private: post: description: 执行操作Private operationId: loadbalanceracl_PerformPrivate parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalanceracl: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceracl_PerformPrivateOutput' summary: 执行操作Private tags: - loadbalanceracl /loadbalanceracls/{id}/public: post: description: 执行操作Public operationId: loadbalanceracl_PerformPublic parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalanceracl: $ref: '#/definitions/PerformPublicProjectInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceracl_PerformPublicOutput' summary: 执行操作Public tags: - loadbalanceracl /loadbalanceracls/{id}/purge: post: description: 执行操作Purge operationId: loadbalanceracl_PerformPurge parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceracl_PerformPurgeOutput' summary: 执行操作Purge tags: - loadbalanceracl /loadbalanceracls/{id}/status: get: description: 获取指定信息Status operationId: loadbalanceracl_GetDetailsStatus parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceracl_GetDetailsStatusOutput' summary: 获取资源状态 tags: - loadbalanceracl /loadbalanceracls/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: loadbalanceracl_PerformSyncstatus parameters: - description: The Id or Name of loadbalanceracl in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceracl_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - loadbalanceracl /loadbalanceragents: get: description: 列表 operationId: loadbalanceragent_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 区域名称或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/loadbalanceragent_ListItemFilterOutput' summary: 负载均衡Agent列表 tags: - loadbalanceragent post: description: 新建 operationId: loadbalanceragent_ValidateCreateData responses: "200": $ref: '#/responses/loadbalanceragent_ValidateCreateDataOutput' summary: 新建 tags: - loadbalanceragent /loadbalanceragents/{id}: delete: description: 删除 operationId: loadbalanceragent_CustomizeDelete parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceragent_CustomizeDeleteOutput' summary: 删除 tags: - loadbalanceragent get: description: 获取详情 operationId: loadbalanceragent_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceragent_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalanceragent put: description: 更新 operationId: loadbalanceragent_ValidateUpdateData parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceragent_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalanceragent /loadbalanceragents/{id}/deploy: post: description: 执行操作Deploy operationId: loadbalanceragent_PerformDeploy parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalanceragent: $ref: '#/definitions/LoadbalancerAgentDeployInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceragent_PerformDeployOutput' summary: 执行操作Deploy tags: - loadbalanceragent /loadbalanceragents/{id}/hb: post: description: 执行操作Hb operationId: loadbalanceragent_PerformHb parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceragent_PerformHbOutput' summary: 执行操作Hb tags: - loadbalanceragent /loadbalanceragents/{id}/join-cluster: post: description: 执行操作JoinCluster operationId: loadbalanceragent_PerformJoinCluster parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalanceragent: $ref: '#/definitions/LoadbalancerAgentJoinClusterInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceragent_PerformJoinClusterOutput' summary: 执行操作JoinCluster tags: - loadbalanceragent /loadbalanceragents/{id}/leave-cluster: post: description: 执行操作LeaveCluster operationId: loadbalanceragent_PerformLeaveCluster parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalanceragent: $ref: '#/definitions/LoadbalancerAgentLeaveClusterInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalanceragent_PerformLeaveClusterOutput' summary: 执行操作LeaveCluster tags: - loadbalanceragent /loadbalanceragents/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalanceragent_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceragent_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalanceragent /loadbalanceragents/{id}/params-patch: post: description: 执行操作ParamsPatch operationId: loadbalanceragent_PerformParamsPatch parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceragent_PerformParamsPatchOutput' summary: 执行操作ParamsPatch tags: - loadbalanceragent /loadbalanceragents/{id}/undeploy: post: description: 执行操作Undeploy operationId: loadbalanceragent_PerformUndeploy parameters: - description: The Id or Name of loadbalanceragent in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalanceragent_PerformUndeployOutput' summary: 执行操作Undeploy tags: - loadbalanceragent /loadbalanceragents/default-params: get: description: 获取指定资源类的信息DefaultParams operationId: loadbalanceragent_GetPropertyDefaultParams responses: "200": $ref: '#/responses/loadbalanceragent_GetPropertyDefaultParamsOutput' summary: 获取指定资源类的信息DefaultParams tags: - loadbalanceragent /loadbalancerbackendgroups: get: description: 列表 operationId: loadbalancerbackendgroup_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/loadbalancerbackendgroup_ListItemFilterOutput' summary: 负载均衡后端服务器组列表 tags: - loadbalancerbackendgroup post: description: 新建 operationId: loadbalancerbackendgroup_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count loadbalancerbackendgroup: $ref: '#/definitions/LoadbalancerBackendGroupCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerbackendgroup_ValidateCreateDataOutput' summary: 新建 tags: - loadbalancerbackendgroup /loadbalancerbackendgroups/{id}: delete: description: 删除 operationId: loadbalancerbackendgroup_CustomizeDelete parameters: - description: The Id or Name of loadbalancerbackendgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackendgroup_CustomizeDeleteOutput' summary: 删除 tags: - loadbalancerbackendgroup get: description: 获取详情 operationId: loadbalancerbackendgroup_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalancerbackendgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackendgroup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalancerbackendgroup put: description: 更新 operationId: loadbalancerbackendgroup_ValidateUpdateData parameters: - description: The Id or Name of loadbalancerbackendgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancerbackendgroup: $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerbackendgroup_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalancerbackendgroup /loadbalancerbackendgroups/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalancerbackendgroup_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of loadbalancerbackendgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackendgroup_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalancerbackendgroup /loadbalancerbackendgroups/{id}/purge: post: description: 执行操作Purge operationId: loadbalancerbackendgroup_PerformPurge parameters: - description: The Id or Name of loadbalancerbackendgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackendgroup_PerformPurgeOutput' summary: 执行操作Purge tags: - loadbalancerbackendgroup /loadbalancerbackendgroups/{id}/status: get: description: 获取指定信息Status operationId: loadbalancerbackendgroup_GetDetailsStatus parameters: - description: The Id or Name of loadbalancerbackendgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackendgroup_GetDetailsStatusOutput' summary: 获取资源状态 tags: - loadbalancerbackendgroup /loadbalancerbackends: get: description: 列表 operationId: loadbalancerbackend_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/loadbalancerbackend_ListItemFilterOutput' summary: 负载均衡后端列表 tags: - loadbalancerbackend post: description: 新建 operationId: loadbalancerbackend_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count loadbalancerbackend: $ref: '#/definitions/LoadbalancerBackendCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerbackend_ValidateCreateDataOutput' summary: 新建 tags: - loadbalancerbackend /loadbalancerbackends/{id}: delete: description: 删除 operationId: loadbalancerbackend_CustomizeDelete parameters: - description: The Id or Name of loadbalancerbackend in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackend_CustomizeDeleteOutput' summary: 删除 tags: - loadbalancerbackend get: description: 获取详情 operationId: loadbalancerbackend_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalancerbackend in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackend_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalancerbackend put: description: 更新 operationId: loadbalancerbackend_ValidateUpdateData parameters: - description: The Id or Name of loadbalancerbackend in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancerbackend: $ref: '#/definitions/LoadbalancerBackendUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerbackend_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalancerbackend /loadbalancerbackends/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalancerbackend_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of loadbalancerbackend in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackend_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalancerbackend /loadbalancerbackends/{id}/purge: post: description: 执行操作Purge operationId: loadbalancerbackend_PerformPurge parameters: - description: The Id or Name of loadbalancerbackend in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackend_PerformPurgeOutput' summary: 执行操作Purge tags: - loadbalancerbackend /loadbalancerbackends/{id}/status: get: description: 获取指定信息Status operationId: loadbalancerbackend_GetDetailsStatus parameters: - description: The Id or Name of loadbalancerbackend in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerbackend_GetDetailsStatusOutput' summary: 获取资源状态 tags: - loadbalancerbackend /loadbalancercertificates: get: description: 列表 operationId: loadbalancercertificate_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/loadbalancercertificate_ListItemFilterOutput' summary: 列表 tags: - loadbalancercertificate post: description: 新建 operationId: loadbalancercertificate_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count loadbalancercertificate: $ref: '#/definitions/LoadbalancerCertificateCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancercertificate_ValidateCreateDataOutput' summary: 新建 tags: - loadbalancercertificate /loadbalancercertificates/{id}: delete: description: 删除 operationId: loadbalancercertificate_CustomizeDelete parameters: - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercertificate_CustomizeDeleteOutput' summary: 删除 tags: - loadbalancercertificate get: description: 获取详情 operationId: loadbalancercertificate_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercertificate_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalancercertificate put: description: 更新 operationId: loadbalancercertificate_ValidateUpdateData parameters: - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancercertificate: $ref: '#/definitions/LoadbalancerCertificateUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancercertificate_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalancercertificate /loadbalancercertificates/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: loadbalancercertificate_PerformChangeOwner parameters: - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancercertificate: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancercertificate_PerformChangeOwnerOutput' summary: 更改项目 tags: - loadbalancercertificate /loadbalancercertificates/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalancercertificate_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercertificate_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalancercertificate /loadbalancercertificates/{id}/private: post: description: 执行操作Private operationId: loadbalancercertificate_PerformPrivate parameters: - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancercertificate: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancercertificate_PerformPrivateOutput' summary: 执行操作Private tags: - loadbalancercertificate /loadbalancercertificates/{id}/public: post: description: 执行操作Public operationId: loadbalancercertificate_PerformPublic parameters: - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancercertificate: $ref: '#/definitions/PerformPublicProjectInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancercertificate_PerformPublicOutput' summary: 执行操作Public tags: - loadbalancercertificate /loadbalancercertificates/{id}/status: get: description: 获取指定信息Status operationId: loadbalancercertificate_GetDetailsStatus parameters: - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercertificate_GetDetailsStatusOutput' summary: 获取资源状态 tags: - loadbalancercertificate /loadbalancercertificates/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: loadbalancercertificate_PerformSyncstatus parameters: - description: The Id or Name of loadbalancercertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercertificate_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - loadbalancercertificate /loadbalancerclusters: get: description: 列表 operationId: loadbalancercluster_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 区域名称或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/loadbalancercluster_ListItemFilterOutput' summary: 负载均衡集群列表 tags: - loadbalancercluster post: description: 新建 operationId: loadbalancercluster_ValidateCreateData responses: "200": $ref: '#/responses/loadbalancercluster_ValidateCreateDataOutput' summary: 新建 tags: - loadbalancercluster /loadbalancerclusters/{id}: delete: description: 删除 operationId: loadbalancercluster_CustomizeDelete parameters: - description: The Id or Name of loadbalancercluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercluster_CustomizeDeleteOutput' summary: 删除 tags: - loadbalancercluster get: description: 获取详情 operationId: loadbalancercluster_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalancercluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercluster_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalancercluster put: description: 更新 operationId: loadbalancercluster_ValidateUpdateData parameters: - description: The Id or Name of loadbalancercluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercluster_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalancercluster /loadbalancerclusters/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalancercluster_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of loadbalancercluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercluster_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalancercluster /loadbalancerclusters/{id}/params-patch: post: description: 执行操作ParamsPatch operationId: loadbalancercluster_PerformParamsPatch parameters: - description: The Id or Name of loadbalancercluster in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancercluster_PerformParamsPatchOutput' summary: 执行操作ParamsPatch tags: - loadbalancercluster /loadbalancerhealthchecks: get: description: 列表 operationId: loadbalancer_health_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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_health_check_ListItemFilterOutput' summary: 健康检查列表 tags: - loadbalancer_health_check post: description: 新建 operationId: loadbalancer_health_check_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count loadbalancer_health_check: $ref: '#/definitions/SLoadbalancerHealthCheckCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancer_health_check_ValidateCreateDataOutput' summary: 新建 tags: - loadbalancer_health_check /loadbalancerhealthchecks/{id}: delete: description: 删除 operationId: loadbalancer_health_check_CustomizeDelete parameters: - description: The Id or Name of loadbalancer_health_check in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancer_health_check_CustomizeDeleteOutput' summary: 删除 tags: - loadbalancer_health_check get: description: 获取详情 operationId: loadbalancer_health_check_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalancer_health_check in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancer_health_check_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalancer_health_check put: description: 更新 operationId: loadbalancer_health_check_ValidateUpdateData parameters: - description: The Id or Name of loadbalancer_health_check in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancer_health_check: $ref: '#/definitions/SLoadbalancerHealthCheckUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancer_health_check_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalancer_health_check /loadbalancerhealthchecks/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: loadbalancer_health_check_PerformChangeOwner parameters: - description: The Id or Name of loadbalancer_health_check in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancer_health_check: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancer_health_check_PerformChangeOwnerOutput' summary: 更改项目 tags: - loadbalancer_health_check /loadbalancerhealthchecks/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalancer_health_check_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: 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_health_check in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancer_health_check_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalancer_health_check /loadbalancerhealthchecks/{id}/status: get: description: 获取指定信息Status operationId: loadbalancer_health_check_GetDetailsStatus parameters: - description: The Id or Name of loadbalancer_health_check in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancer_health_check_GetDetailsStatusOutput' summary: 获取资源状态 tags: - loadbalancer_health_check /loadbalancerhealthchecks/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: loadbalancer_health_check_PerformSyncstatus parameters: - description: The Id or Name of loadbalancer_health_check in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancer_health_check_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - loadbalancer_health_check /loadbalancerlistenerrules: get: description: 列表 operationId: loadbalancerlistenerrule_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/loadbalancerlistenerrule_ListItemFilterOutput' summary: 负载均衡监听器规则列表 tags: - loadbalancerlistenerrule post: description: 新建 operationId: loadbalancerlistenerrule_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count loadbalancerlistenerrule: $ref: '#/definitions/LoadbalancerListenerRuleCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerlistenerrule_ValidateCreateDataOutput' summary: 新建 tags: - loadbalancerlistenerrule /loadbalancerlistenerrules/{id}: delete: description: 删除 operationId: loadbalancerlistenerrule_CustomizeDelete parameters: - description: The Id or Name of loadbalancerlistenerrule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistenerrule_CustomizeDeleteOutput' summary: 删除 tags: - loadbalancerlistenerrule get: description: 获取详情 operationId: loadbalancerlistenerrule_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalancerlistenerrule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistenerrule_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalancerlistenerrule put: description: 更新 operationId: loadbalancerlistenerrule_ValidateUpdateData parameters: - description: The Id or Name of loadbalancerlistenerrule in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancerlistenerrule: $ref: '#/definitions/LoadbalancerListenerRuleUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerlistenerrule_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalancerlistenerrule /loadbalancerlistenerrules/{id}/backend-status: get: description: 获取指定信息BackendStatus operationId: loadbalancerlistenerrule_GetDetailsBackendStatus parameters: - description: The Id or Name of loadbalancerlistenerrule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistenerrule_GetDetailsBackendStatusOutput' summary: 获取指定信息BackendStatus tags: - loadbalancerlistenerrule /loadbalancerlistenerrules/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalancerlistenerrule_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of loadbalancerlistenerrule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistenerrule_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalancerlistenerrule /loadbalancerlistenerrules/{id}/purge: post: description: 执行操作Purge operationId: loadbalancerlistenerrule_PerformPurge parameters: - description: The Id or Name of loadbalancerlistenerrule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistenerrule_PerformPurgeOutput' summary: 执行操作Purge tags: - loadbalancerlistenerrule /loadbalancerlistenerrules/{id}/status: get: description: 获取指定信息Status operationId: loadbalancerlistenerrule_GetDetailsStatus parameters: - description: The Id or Name of loadbalancerlistenerrule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistenerrule_GetDetailsStatusOutput' summary: 获取资源状态 tags: - loadbalancerlistenerrule /loadbalancerlisteners: get: description: 列表 operationId: loadbalancerlistener_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/loadbalancerlistener_ListItemFilterOutput' summary: 负载均衡监听器Listener列表 tags: - loadbalancerlistener post: description: 新建 operationId: loadbalancerlistener_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count loadbalancerlistener: $ref: '#/definitions/LoadbalancerListenerCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerlistener_ValidateCreateDataOutput' summary: 新建 tags: - loadbalancerlistener /loadbalancerlisteners/{id}: delete: description: 删除 operationId: loadbalancerlistener_CustomizeDelete parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistener_CustomizeDeleteOutput' summary: 删除 tags: - loadbalancerlistener get: description: 获取详情 operationId: loadbalancerlistener_FetchCustomizeColumns parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistener_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - loadbalancerlistener put: description: 更新 operationId: loadbalancerlistener_ValidateUpdateData parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancerlistener: $ref: '#/definitions/LoadbalancerListenerUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerlistener_ValidateUpdateDataOutput' summary: 更新 tags: - loadbalancerlistener /loadbalancerlisteners/{id}/backend-status: get: description: 获取指定信息BackendStatus operationId: loadbalancerlistener_GetDetailsBackendStatus parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistener_GetDetailsBackendStatusOutput' summary: 获取指定信息BackendStatus tags: - loadbalancerlistener /loadbalancerlisteners/{id}/metadata: get: description: 获取指定信息Metadata operationId: loadbalancerlistener_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistener_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - loadbalancerlistener /loadbalancerlisteners/{id}/purge: post: description: 执行操作Purge operationId: loadbalancerlistener_PerformPurge parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistener_PerformPurgeOutput' summary: 执行操作Purge tags: - loadbalancerlistener /loadbalancerlisteners/{id}/status: get: description: 获取指定信息Status operationId: loadbalancerlistener_GetDetailsStatus parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistener_GetDetailsStatusOutput' summary: 获取资源状态 tags: - loadbalancerlistener post: description: 执行操作Status operationId: loadbalancerlistener_PerformStatus parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: loadbalancerlistener: $ref: '#/definitions/PerformStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/loadbalancerlistener_PerformStatusOutput' summary: 执行操作Status tags: - loadbalancerlistener /loadbalancerlisteners/{id}/sync: post: description: 执行操作Sync operationId: loadbalancerlistener_PerformSync parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistener_PerformSyncOutput' summary: 执行操作Sync tags: - loadbalancerlistener /loadbalancerlisteners/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: loadbalancerlistener_PerformSyncstatus parameters: - description: The Id or Name of loadbalancerlistener in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/loadbalancerlistener_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - loadbalancerlistener /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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: processor_type type: string x-go-name: ProcessorType - in: query name: cpu_arch type: string x-go-name: CpuArch 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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 /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 /mongodbs: get: description: 列表 operationId: mongodb_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/mongodb_ListItemFilterOutput' summary: MongoDB实例列表 tags: - mongodb post: description: 新建 operationId: mongodb_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count mongodb: $ref: '#/definitions/MongoDBCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/mongodb_ValidateCreateDataOutput' summary: 新建 tags: - mongodb /mongodbs/{id}: delete: description: 删除 operationId: mongodb_CustomizeDelete parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/mongodb_CustomizeDeleteOutput' summary: 删除 tags: - mongodb get: description: 获取详情 operationId: mongodb_FetchCustomizeColumns parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/mongodb_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - mongodb put: description: 更新 operationId: mongodb_ValidateUpdateData parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: mongodb: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/mongodb_ValidateUpdateDataOutput' summary: 更新 tags: - mongodb /mongodbs/{id}/backups: get: description: 获取指定信息Backups operationId: mongodb_GetDetailsBackups parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/mongodb_GetDetailsBackupsOutput' summary: 获取备份列表 tags: - mongodb /mongodbs/{id}/cancel-expire: post: description: 执行操作CancelExpire operationId: mongodb_PerformCancelExpire parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/mongodb_PerformCancelExpireOutput' summary: 执行操作CancelExpire tags: - mongodb /mongodbs/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: mongodb_PerformChangeOwner parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: mongodb: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/mongodb_PerformChangeOwnerOutput' summary: 更改项目 tags: - mongodb /mongodbs/{id}/metadata: get: description: 获取指定信息Metadata operationId: mongodb_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/mongodb_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - mongodb /mongodbs/{id}/postpaid-expire: post: description: 执行操作PostpaidExpire operationId: mongodb_PerformPostpaidExpire parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: mongodb: $ref: '#/definitions/PostpaidExpireInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/mongodb_PerformPostpaidExpireOutput' summary: 执行操作PostpaidExpire tags: - mongodb /mongodbs/{id}/remote-update: post: description: 执行操作RemoteUpdate operationId: mongodb_PerformRemoteUpdate parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: mongodb: $ref: '#/definitions/MongoDBRemoteUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/mongodb_PerformRemoteUpdateOutput' summary: 执行操作RemoteUpdate tags: - mongodb /mongodbs/{id}/status: get: description: 获取指定信息Status operationId: mongodb_GetDetailsStatus parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/mongodb_GetDetailsStatusOutput' summary: 获取资源状态 tags: - mongodb /mongodbs/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: mongodb_PerformSyncstatus parameters: - description: The Id or Name of mongodb in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/mongodb_PerformSyncstatusOutput' summary: 同步MongoDB实例状态 tags: - mongodb /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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: override_pending_delete type: boolean x-go-name: OverridePendingDelete - default: false description: 是否仅删除本地资源 in: query name: purge type: boolean x-go-name: Purge - default: false description: 是否删除快照 in: query name: delete_snapshots type: boolean x-go-name: DeleteSnapshots - default: false description: 是否删除关联的EIP in: query name: delete_eip type: boolean x-go-name: DeleteEip - default: false description: 是否删除关联的数据盘 in: query name: delete_disks type: boolean x-go-name: DeleteDisks - 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}/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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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}/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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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}/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}/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 /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 /natdentries: get: description: 列表 operationId: natdentry_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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/natdentry_ListItemFilterOutput' summary: NAT网关的目的地址转换规则列表 tags: - natdentry post: description: 新建 operationId: natdentry_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count natdentry: $ref: '#/definitions/SNatDCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natdentry_ValidateCreateDataOutput' summary: 新建 tags: - natdentry /natdentries/{id}: delete: description: 删除 operationId: natdentry_CustomizeDelete parameters: - description: The Id or Name of natdentry in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natdentry_CustomizeDeleteOutput' summary: 删除 tags: - natdentry get: description: 获取详情 operationId: natdentry_FetchCustomizeColumns parameters: - description: The Id or Name of natdentry in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natdentry_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - natdentry put: description: 更新 operationId: natdentry_ValidateUpdateData parameters: - description: The Id or Name of natdentry in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natdentry: $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natdentry_ValidateUpdateDataOutput' summary: 更新 tags: - natdentry /natdentries/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: natdentry_PerformChangeOwner parameters: - description: The Id or Name of natdentry in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natdentry: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natdentry_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - natdentry /natdentries/{id}/metadata: get: description: 获取指定信息Metadata operationId: natdentry_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of natdentry in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natdentry_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - natdentry /natdentries/{id}/private: post: description: 执行操作Private operationId: natdentry_PerformPrivate parameters: - description: The Id or Name of natdentry in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natdentry: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natdentry_PerformPrivateOutput' summary: 执行操作Private tags: - natdentry /natdentries/{id}/public: post: description: 执行操作Public operationId: natdentry_PerformPublic parameters: - description: The Id or Name of natdentry in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natdentry: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natdentry_PerformPublicOutput' summary: 执行操作Public tags: - natdentry /natdentries/{id}/status: get: description: 获取指定信息Status operationId: natdentry_GetDetailsStatus parameters: - description: The Id or Name of natdentry in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natdentry_GetDetailsStatusOutput' summary: 获取资源状态 tags: - natdentry /natgateways: get: description: 列表 operationId: natgateway_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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/natgateway_ListItemFilterOutput' summary: NAT网关列表 tags: - natgateway post: description: 新建 operationId: natgateway_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count natgateway: $ref: '#/definitions/NatgatewayCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_ValidateCreateDataOutput' summary: 新建 tags: - natgateway /natgateways/{id}: delete: description: 删除 operationId: natgateway_CustomizeDelete parameters: - default: false description: 是否越过回收站直接删除 in: query name: override_pending_delete type: boolean x-go-name: OverridePendingDelete - default: false description: 是否仅删除本地资源 in: query name: purge type: boolean x-go-name: Purge - default: false description: 是否删除快照 in: query name: delete_snapshots type: boolean x-go-name: DeleteSnapshots - default: false description: 是否删除关联的EIP in: query name: delete_eip type: boolean x-go-name: DeleteEip - default: false description: 是否删除关联的数据盘 in: query name: delete_disks type: boolean x-go-name: DeleteDisks - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/NatgatewayDeleteInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_CustomizeDeleteOutput' summary: 删除NAT tags: - natgateway get: description: 获取详情 operationId: natgateway_FetchCustomizeColumns parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natgateway_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - natgateway put: description: 更新 operationId: natgateway_ValidateUpdateData parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_ValidateUpdateDataOutput' summary: 更新 tags: - natgateway /natgateways/{id}/cancel-expire: post: description: 执行操作CancelExpire operationId: natgateway_PerformCancelExpire parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natgateway_PerformCancelExpireOutput' summary: 执行操作CancelExpire tags: - natgateway /natgateways/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: natgateway_PerformChangeOwner parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - natgateway /natgateways/{id}/dnat-resources: post: description: 执行操作DnatResources operationId: natgateway_PerformDnatResources parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natgateway_PerformDnatResourcesOutput' summary: 执行操作DnatResources tags: - natgateway /natgateways/{id}/metadata: get: description: 获取指定信息Metadata operationId: natgateway_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natgateway_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - natgateway /natgateways/{id}/postpaid-expire: post: description: 执行操作PostpaidExpire operationId: natgateway_PerformPostpaidExpire parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/PostpaidExpireInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_PerformPostpaidExpireOutput' summary: 执行操作PostpaidExpire tags: - natgateway /natgateways/{id}/private: post: description: 执行操作Private operationId: natgateway_PerformPrivate parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_PerformPrivateOutput' summary: 执行操作Private tags: - natgateway /natgateways/{id}/public: post: description: 执行操作Public operationId: natgateway_PerformPublic parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_PerformPublicOutput' summary: 执行操作Public tags: - natgateway /natgateways/{id}/remote-update: post: description: 执行操作RemoteUpdate operationId: natgateway_PerformRemoteUpdate parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/MongoDBRemoteUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_PerformRemoteUpdateOutput' summary: 执行操作RemoteUpdate tags: - natgateway /natgateways/{id}/renew: post: description: 执行操作Renew operationId: natgateway_PerformRenew parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/RenewInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_PerformRenewOutput' summary: 执行操作Renew tags: - natgateway /natgateways/{id}/set-auto-renew: post: description: |- 要求NAT状态为available 要求NAT计费类型为包年包月(预付费) operationId: natgateway_PerformSetAutoRenew parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/AutoRenewInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_PerformSetAutoRenewOutput' summary: 设置自动续费 tags: - natgateway /natgateways/{id}/snat-resources: post: description: 执行操作SnatResources operationId: natgateway_PerformSnatResources parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natgateway_PerformSnatResourcesOutput' summary: 执行操作SnatResources tags: - natgateway /natgateways/{id}/status: get: description: 获取指定信息Status operationId: natgateway_GetDetailsStatus parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natgateway_GetDetailsStatusOutput' summary: 获取资源状态 tags: - natgateway /natgateways/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: natgateway_PerformSyncstatus parameters: - description: The Id or Name of natgateway in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natgateway: $ref: '#/definitions/NatGatewaySyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natgateway_PerformSyncstatusOutput' summary: 同步NAT网关状态 tags: - natgateway /natsenties: get: description: 列表 operationId: natsentry_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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/natsentry_ListItemFilterOutput' summary: NAT网关的源地址转换规则列表 tags: - natsentry post: description: 新建 operationId: natsentry_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count natsentry: $ref: '#/definitions/SNatSCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natsentry_ValidateCreateDataOutput' summary: 新建 tags: - natsentry /natsenties/{id}: delete: description: 删除 operationId: natsentry_CustomizeDelete parameters: - description: The Id or Name of natsentry in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natsentry_CustomizeDeleteOutput' summary: 删除 tags: - natsentry get: description: 获取详情 operationId: natsentry_FetchCustomizeColumns parameters: - description: The Id or Name of natsentry in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natsentry_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - natsentry put: description: 更新 operationId: natsentry_ValidateUpdateData parameters: - description: The Id or Name of natsentry in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natsentry: $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natsentry_ValidateUpdateDataOutput' summary: 更新 tags: - natsentry /natsenties/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: natsentry_PerformChangeOwner parameters: - description: The Id or Name of natsentry in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natsentry: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natsentry_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - natsentry /natsenties/{id}/metadata: get: description: 获取指定信息Metadata operationId: natsentry_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of natsentry in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natsentry_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - natsentry /natsenties/{id}/private: post: description: 执行操作Private operationId: natsentry_PerformPrivate parameters: - description: The Id or Name of natsentry in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natsentry: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natsentry_PerformPrivateOutput' summary: 执行操作Private tags: - natsentry /natsenties/{id}/public: post: description: 执行操作Public operationId: natsentry_PerformPublic parameters: - description: The Id or Name of natsentry in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: natsentry: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/natsentry_PerformPublicOutput' summary: 执行操作Public tags: - natsentry /natsenties/{id}/status: get: description: 获取指定信息Status operationId: natsentry_GetDetailsStatus parameters: - description: The Id or Name of natsentry in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/natsentry_GetDetailsStatusOutput' summary: 获取资源状态 tags: - natsentry /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats 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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - 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}/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/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 /networkaddresses: get: description: 列表 operationId: networkaddress_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 关联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 - 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: guest_id type: array x-go-name: GuestId responses: "200": $ref: '#/responses/networkaddress_ListItemFilterOutput' summary: 列表 tags: - networkaddress post: description: 新建 operationId: networkaddress_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count networkaddress: $ref: '#/definitions/NetworkAddressCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/networkaddress_ValidateCreateDataOutput' summary: 新建 tags: - networkaddress /networkaddresses/{id}: delete: description: 删除 operationId: networkaddress_CustomizeDelete parameters: - description: The Id or Name of networkaddress in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/networkaddress_CustomizeDeleteOutput' summary: 删除 tags: - networkaddress get: description: 获取详情 operationId: networkaddress_FetchCustomizeColumns parameters: - description: The Id or Name of networkaddress in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/networkaddress_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - networkaddress put: description: 更新 operationId: networkaddress_ValidateUpdateData parameters: - description: The Id or Name of networkaddress in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: networkaddress: $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/networkaddress_ValidateUpdateDataOutput' summary: 更新 tags: - networkaddress /networkaddresses/{id}/metadata: get: description: 获取指定信息Metadata operationId: networkaddress_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of networkaddress in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/networkaddress_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - networkaddress /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats 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 /networkinterfaces: get: description: 列表 operationId: networkinterface_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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/networkinterface_ListItemFilterOutput' summary: 虚拟网卡列表 tags: - networkinterface post: description: 新建 operationId: networkinterface_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count networkinterface: $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/networkinterface_ValidateCreateDataOutput' summary: 新建 tags: - networkinterface /networkinterfaces/{id}: delete: description: 删除 operationId: networkinterface_CustomizeDelete parameters: - description: The Id or Name of networkinterface in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/networkinterface_CustomizeDeleteOutput' summary: 删除 tags: - networkinterface get: description: 获取详情 operationId: networkinterface_FetchCustomizeColumns parameters: - description: The Id or Name of networkinterface in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/networkinterface_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - networkinterface put: description: 更新 operationId: networkinterface_ValidateUpdateData parameters: - description: The Id or Name of networkinterface in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: networkinterface: $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/networkinterface_ValidateUpdateDataOutput' summary: 更新 tags: - networkinterface /networkinterfaces/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: networkinterface_PerformChangeOwner parameters: - description: The Id or Name of networkinterface in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: networkinterface: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/networkinterface_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - networkinterface /networkinterfaces/{id}/metadata: get: description: 获取指定信息Metadata operationId: networkinterface_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of networkinterface in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/networkinterface_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - networkinterface /networkinterfaces/{id}/private: post: description: 执行操作Private operationId: networkinterface_PerformPrivate parameters: - description: The Id or Name of networkinterface in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: networkinterface: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/networkinterface_PerformPrivateOutput' summary: 执行操作Private tags: - networkinterface /networkinterfaces/{id}/public: post: description: 执行操作Public operationId: networkinterface_PerformPublic parameters: - description: The Id or Name of networkinterface in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: networkinterface: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/networkinterface_PerformPublicOutput' summary: 执行操作Public tags: - networkinterface /networkinterfaces/{id}/status: get: description: 获取指定信息Status operationId: networkinterface_GetDetailsStatus parameters: - description: The Id or Name of networkinterface in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/networkinterface_GetDetailsStatusOutput' summary: 获取资源状态 tags: - networkinterface /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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}/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-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}/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/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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 指定项目归属域名称或ID in: query name: project_domain_id type: string x-go-name: ProjectDomainId - description: 对具有域属性的资源，严格匹配域ID in: query items: type: string name: project_domain_ids type: array x-go-name: ProjectDomainIds - description: 按domain名称排序，可能值为asc|desc in: query name: order_by_domain pattern: asc|desc type: string x-go-name: OrderByDomain - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: domain_tags x-go-name: DomainTags - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: no_domain_tags x-go-name: NoDomainTags - description: |- 列出指定云平台的资源，支持的云平台如下 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 - 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 x-go-name: Policydefinition 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: 更改项目 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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 指定项目归属域名称或ID in: query name: project_domain_id type: string x-go-name: ProjectDomainId - description: 对具有域属性的资源，严格匹配域ID in: query items: type: string name: project_domain_ids type: array x-go-name: ProjectDomainIds - description: 按domain名称排序，可能值为asc|desc in: query name: order_by_domain pattern: asc|desc type: string x-go-name: OrderByDomain - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: domain_tags x-go-name: DomainTags - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: no_domain_tags x-go-name: NoDomainTags - description: 以资源是否共享过滤列表 in: query name: is_public type: boolean x-go-name: IsPublic - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project in: query name: public_scope type: string x-go-name: PublicScope - description: 以资源的状态过滤列表 in: query items: type: string name: status type: array x-go-name: Status - description: 以资源是否启用/禁用过滤列表 in: query 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}/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}/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 /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: 配额所属范围，可能值为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: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - 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 - 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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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}/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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names 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}/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_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: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - 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 - 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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats 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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names 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}/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 /scalingactivities: get: description: 列表 operationId: scalingactivity_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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/scalingactivity_ListItemFilterOutput' summary: 列表 tags: - scalingactivity post: description: 新建 operationId: scalingactivity_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count scalingactivity: $ref: '#/definitions/StatusStandaloneResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalingactivity_ValidateCreateDataOutput' summary: 新建 tags: - scalingactivity /scalingactivities/{id}: delete: description: 删除 operationId: scalingactivity_CustomizeDelete parameters: - description: The Id or Name of scalingactivity in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingactivity_CustomizeDeleteOutput' summary: 删除 tags: - scalingactivity get: description: 获取详情 operationId: scalingactivity_FetchCustomizeColumns parameters: - description: The Id or Name of scalingactivity in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingactivity_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - scalingactivity put: description: 更新 operationId: scalingactivity_ValidateUpdateData parameters: - description: The Id or Name of scalingactivity in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalingactivity: $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalingactivity_ValidateUpdateDataOutput' summary: 更新 tags: - scalingactivity /scalingactivities/{id}/metadata: get: description: 获取指定信息Metadata operationId: scalingactivity_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of scalingactivity in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingactivity_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - scalingactivity /scalingactivities/{id}/status: get: description: 获取指定信息Status operationId: scalingactivity_GetDetailsStatus parameters: - description: The Id or Name of scalingactivity in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingactivity_GetDetailsStatusOutput' summary: 获取资源状态 tags: - scalingactivity /scalinggroups: get: description: 列表 operationId: scalinggroup_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/scalinggroup_ListItemFilterOutput' summary: 列表 tags: - scalinggroup post: description: 新建 operationId: scalinggroup_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count scalinggroup: $ref: '#/definitions/ScalingGroupCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalinggroup_ValidateCreateDataOutput' summary: 新建 tags: - scalinggroup /scalinggroups/{id}: delete: description: 删除 operationId: scalinggroup_CustomizeDelete parameters: - description: The Id or Name of scalinggroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalinggroup_CustomizeDeleteOutput' summary: 删除 tags: - scalinggroup get: description: 获取详情 operationId: scalinggroup_FetchCustomizeColumns parameters: - description: The Id or Name of scalinggroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalinggroup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - scalinggroup put: description: 更新 operationId: scalinggroup_ValidateUpdateData parameters: - description: The Id or Name of scalinggroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalinggroup: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalinggroup_ValidateUpdateDataOutput' summary: 更新 tags: - scalinggroup /scalinggroups/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: scalinggroup_PerformChangeOwner parameters: - description: The Id or Name of scalinggroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalinggroup: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalinggroup_PerformChangeOwnerOutput' summary: 更改项目 tags: - scalinggroup /scalinggroups/{id}/disable: post: description: 执行操作Disable operationId: scalinggroup_PerformDisable parameters: - description: The Id or Name of scalinggroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalinggroup: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalinggroup_PerformDisableOutput' summary: 执行操作Disable tags: - scalinggroup /scalinggroups/{id}/enable: post: description: 执行操作Enable operationId: scalinggroup_PerformEnable parameters: - description: The Id or Name of scalinggroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalinggroup: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalinggroup_PerformEnableOutput' summary: 执行操作Enable tags: - scalinggroup /scalinggroups/{id}/metadata: get: description: 获取指定信息Metadata operationId: scalinggroup_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of scalinggroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalinggroup_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - scalinggroup /scalinggroups/{id}/status: get: description: 获取指定信息Status operationId: scalinggroup_GetDetailsStatus parameters: - description: The Id or Name of scalinggroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalinggroup_GetDetailsStatusOutput' summary: 获取资源状态 tags: - scalinggroup /scalingpolicies: get: description: 列表 operationId: scalingpolicy_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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/scalingpolicy_ListItemFilterOutput' summary: 列表 tags: - scalingpolicy post: description: 新建 operationId: scalingpolicy_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count scalingpolicy: $ref: '#/definitions/ScalingPolicyCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalingpolicy_ValidateCreateDataOutput' summary: 新建 tags: - scalingpolicy /scalingpolicies/{id}: delete: description: 删除 operationId: scalingpolicy_CustomizeDelete parameters: - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingpolicy_CustomizeDeleteOutput' summary: 删除 tags: - scalingpolicy get: description: 获取详情 operationId: scalingpolicy_FetchCustomizeColumns parameters: - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingpolicy_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - scalingpolicy put: description: 更新 operationId: scalingpolicy_ValidateUpdateData parameters: - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalingpolicy: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalingpolicy_ValidateUpdateDataOutput' summary: 更新 tags: - scalingpolicy /scalingpolicies/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: scalingpolicy_PerformChangeOwner parameters: - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalingpolicy: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalingpolicy_PerformChangeOwnerOutput' summary: 更改项目 tags: - scalingpolicy /scalingpolicies/{id}/disable: post: description: 执行操作Disable operationId: scalingpolicy_PerformDisable parameters: - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalingpolicy: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalingpolicy_PerformDisableOutput' summary: 执行操作Disable tags: - scalingpolicy /scalingpolicies/{id}/enable: post: description: 执行操作Enable operationId: scalingpolicy_PerformEnable parameters: - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: scalingpolicy: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/scalingpolicy_PerformEnableOutput' summary: 执行操作Enable tags: - scalingpolicy /scalingpolicies/{id}/metadata: get: description: 获取指定信息Metadata operationId: scalingpolicy_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingpolicy_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - scalingpolicy /scalingpolicies/{id}/status: get: description: 获取指定信息Status operationId: scalingpolicy_GetDetailsStatus parameters: - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingpolicy_GetDetailsStatusOutput' summary: 获取资源状态 tags: - scalingpolicy /scalingpolicies/{id}/trigger: post: description: 执行操作Trigger operationId: scalingpolicy_PerformTrigger parameters: - description: The Id or Name of scalingpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/scalingpolicy_PerformTriggerOutput' summary: 执行操作Trigger tags: - scalingpolicy /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以关联的调度标签（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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 指定查询的权限范围，可能值为project, domain or system in: query name: scope type: string x-go-name: Scope - description: 指定项目归属域名称或ID in: query name: project_domain_id type: string x-go-name: ProjectDomainId - description: 对具有域属性的资源，严格匹配域ID in: query items: type: string name: project_domain_ids type: array x-go-name: ProjectDomainIds - description: 按domain名称排序，可能值为asc|desc in: query name: order_by_domain pattern: asc|desc type: string x-go-name: OrderByDomain - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: domain_tags x-go-name: DomainTags - $ref: '#/definitions/TTagSetList' description: filter by domain tags in: query name: no_domain_tags x-go-name: NoDomainTags - description: 指定项目的名称或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 - description: filter by zone_id in: query items: type: string name: zone_id type: array x-go-name: ZoneId 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}/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-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 /secgrouprules: get: description: 列表 operationId: secgrouprule_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - 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: 区域名称或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 - 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_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/secgrouprule_ListItemFilterOutput' summary: 安全组规则列表 tags: - secgrouprule post: description: 新建 operationId: secgrouprule_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count secgrouprule: $ref: '#/definitions/SSecgroupRuleCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgrouprule_ValidateCreateDataOutput' summary: 新建 tags: - secgrouprule /secgrouprules/{id}: delete: description: 删除 operationId: secgrouprule_CustomizeDelete parameters: - description: The Id or Name of secgrouprule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/secgrouprule_CustomizeDeleteOutput' summary: 删除 tags: - secgrouprule get: description: 获取详情 operationId: secgrouprule_FetchCustomizeColumns parameters: - description: The Id or Name of secgrouprule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/secgrouprule_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - secgrouprule put: description: 更新 operationId: secgrouprule_ValidateUpdateData parameters: - description: The Id or Name of secgrouprule in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: secgrouprule: $ref: '#/definitions/SSecgroupRuleUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgrouprule_ValidateUpdateDataOutput' summary: 更新 tags: - secgrouprule /secgrouprules/{id}/status: get: description: 获取指定信息Status operationId: secgrouprule_GetDetailsStatus parameters: - description: The Id or Name of secgrouprule in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/secgrouprule_GetDetailsStatusOutput' summary: 获取资源状态 tags: - secgrouprule /secgroups: get: description: 列表 operationId: 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: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/secgroup_ListItemFilterOutput' summary: 安全组列表 tags: - secgroup post: description: 新建 operationId: secgroup_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count secgroup: $ref: '#/definitions/SSecgroupCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgroup_ValidateCreateDataOutput' summary: 新建 tags: - secgroup /secgroups/{id}: delete: description: 删除 operationId: secgroup_CustomizeDelete parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/secgroup_CustomizeDeleteOutput' summary: 删除 tags: - secgroup get: description: 获取详情 operationId: secgroup_FetchCustomizeColumns parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/secgroup_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - secgroup put: description: 更新 operationId: secgroup_ValidateUpdateData parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: secgroup: $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgroup_ValidateUpdateDataOutput' summary: 更新 tags: - secgroup /secgroups/{id}/add-rule: post: description: 执行操作AddRule operationId: secgroup_PerformAddRule parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/secgroup_PerformAddRuleOutput' summary: 执行操作AddRule tags: - secgroup /secgroups/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: secgroup_PerformChangeOwner parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: secgroup: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgroup_PerformChangeOwnerOutput' summary: 更改项目 tags: - secgroup /secgroups/{id}/clone: post: description: 执行操作Clone operationId: secgroup_PerformClone parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: secgroup: $ref: '#/definitions/SecurityGroupCloneInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgroup_PerformCloneOutput' summary: 执行操作Clone tags: - secgroup /secgroups/{id}/import-rules: post: description: 执行操作ImportRules operationId: secgroup_PerformImportRules parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: secgroup: $ref: '#/definitions/SecgroupImportRulesInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgroup_PerformImportRulesOutput' summary: 执行操作ImportRules tags: - secgroup /secgroups/{id}/metadata: get: description: 获取指定信息Metadata operationId: secgroup_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/secgroup_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - secgroup /secgroups/{id}/private: post: description: 执行操作Private operationId: secgroup_PerformPrivate parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: secgroup: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgroup_PerformPrivateOutput' summary: 执行操作Private tags: - secgroup /secgroups/{id}/public: post: description: 执行操作Public operationId: secgroup_PerformPublic parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: secgroup: $ref: '#/definitions/PerformPublicProjectInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgroup_PerformPublicOutput' summary: 执行操作Public tags: - secgroup /secgroups/{id}/status: get: description: 获取指定信息Status operationId: secgroup_GetDetailsStatus parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/secgroup_GetDetailsStatusOutput' summary: 获取资源状态 tags: - secgroup /secgroups/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: secgroup_PerformSyncstatus parameters: - description: The Id or Name of secgroup in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: secgroup: $ref: '#/definitions/SecurityGroupSyncstatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/secgroup_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - secgroup /secgroups/clean: post: description: 执行操作Clean operationId: secgroup_PerformClean responses: "200": $ref: '#/responses/secgroup_PerformCleanOutput' summary: 执行操作Clean tags: - secgroup /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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或名称 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: 区域名称或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 - 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_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 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: 按主机资源类型进行排序 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 - in: query name: snapshotpolicy_id type: string x-go-name: SnapshotpolicyId - description: 是否调度到宿主机上 in: query name: with_host type: boolean x-go-name: WithHost - description: 根据是否绑定快照策略过滤 in: query name: binding_snapshotpolicy type: boolean x-go-name: BindingSnapshotpolicy - description: 根据虚机关联的磁盘是否绑定快照策略过滤 in: query name: binding_disks_snapshotpolicy type: boolean x-go-name: BindingDisksSnapshotpolicy 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: override_pending_delete type: boolean x-go-name: OverridePendingDelete - default: false description: 是否仅删除本地资源 in: query name: purge type: boolean x-go-name: Purge - default: false description: 是否删除快照 in: query name: delete_snapshots type: boolean x-go-name: DeleteSnapshots - default: false description: 是否删除关联的EIP in: query name: delete_eip type: boolean x-go-name: DeleteEip - default: false description: 是否删除关联的数据盘 in: query name: delete_disks type: boolean x-go-name: DeleteDisks - 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-network-secgroup: post: description: 执行操作AddNetworkSecgroup operationId: server_PerformAddNetworkSecgroup 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/GuestNetworkAddSecgroupInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformAddNetworkSecgroupOutput' summary: guest network attach secgroup 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}/bind-snapshotpolicy: post: description: |- 主机只能绑定一个快照策略，已绑定时报错 若主机下任意磁盘已绑定快照策略则报错 operationId: server_PerformBindSnapshotpolicy 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/ServerSnapshotpolicyInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformBindSnapshotpolicyOutput' summary: 绑定主机快照策略 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-billing-type: post: description: 执行操作ChangeBillingType operationId: server_PerformChangeBillingType 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/ServerChangeBillingTypeInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformChangeBillingTypeOutput' summary: 执行操作ChangeBillingType 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-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}/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}/delete-kickstart: post: description: 执行操作DeleteKickstart operationId: server_PerformDeleteKickstart 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_PerformDeleteKickstartOutput' summary: 执行操作DeleteKickstart 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}/disable-auto-merge-snapshots: post: description: 执行操作DisableAutoMergeSnapshots operationId: server_PerformDisableAutoMergeSnapshots 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_PerformDisableAutoMergeSnapshotsOutput' summary: 执行操作DisableAutoMergeSnapshots 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: |- 1. validate guest status, guest hypervisor 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: 创建主机快照 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}/kickstart: get: description: 获取指定信息Kickstart operationId: server_GetDetailsKickstart 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_GetDetailsKickstartOutput' summary: 获取Kickstart信息 tags: - server /servers/{id}/kickstart-complete: post: description: 执行操作KickstartComplete operationId: server_PerformKickstartComplete 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_PerformKickstartCompleteOutput' summary: 执行操作KickstartComplete 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}/numa-info: get: description: 获取指定信息NumaInfo operationId: server_GetDetailsNumaInfo 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_GetDetailsNumaInfoOutput' summary: 获取指定信息NumaInfo 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: 设置定时删除 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}/restore-virtual-isolated-devices: post: description: 执行操作RestoreVirtualIsolatedDevices operationId: server_PerformRestoreVirtualIsolatedDevices 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_PerformRestoreVirtualIsolatedDevicesOutput' summary: 执行操作RestoreVirtualIsolatedDevices 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-network-secgroup: post: description: 执行操作RevokeNetworkSecgroup operationId: server_PerformRevokeNetworkSecgroup 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/GuestRevokeNetworkSecgroupInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformRevokeNetworkSecgroupOutput' summary: 执行操作RevokeNetworkSecgroup 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}/screen-dump: post: description: 执行操作ScreenDump operationId: server_PerformScreenDump 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_PerformScreenDumpOutput' summary: 执行操作ScreenDump tags: - server /servers/{id}/screen-dump-show: get: description: 获取指定信息ScreenDumpShow operationId: server_GetDetailsScreenDumpShow parameters: - in: query name: object_name type: string x-go-name: ObjectName - description: The Id or Name of server in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/server_GetDetailsScreenDumpShowOutput' summary: 获取指定信息ScreenDumpShow 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-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-kickstart: post: description: 执行操作SetKickstart operationId: server_PerformSetKickstart 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/KickstartConfig' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformSetKickstartOutput' summary: 执行操作SetKickstart tags: - server /servers/{id}/set-network-num-queues: post: description: 执行操作SetNetworkNumQueues operationId: server_PerformSetNetworkNumQueues 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/ServerSetNetworkNumQueuesInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformSetNetworkNumQueuesOutput' summary: 执行操作SetNetworkNumQueues tags: - server /servers/{id}/set-network-secgroup: post: description: 执行操作SetNetworkSecgroup operationId: server_PerformSetNetworkSecgroup 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/GuestSetNetworkSecgroupInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformSetNetworkSecgroupOutput' summary: 执行操作SetNetworkSecgroup 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-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-root-disk-matcher: post: description: 执行操作SetRootDiskMatcher operationId: server_PerformSetRootDiskMatcher 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/BaremetalRootDiskMatcher' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformSetRootDiskMatcherOutput' summary: 执行操作SetRootDiskMatcher 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-snapshotpolicy: post: description: 可覆盖当前主机绑定的快照策略，若主机下任意磁盘已绑定快照策略，则自动解除磁盘快照策略 operationId: server_PerformSetSnapshotpolicy 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/ServerSnapshotpolicyInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformSetSnapshotpolicyOutput' 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-tpm: post: description: 执行操作SetTpm operationId: server_PerformSetTpm 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_PerformSetTpmOutput' summary: 执行操作SetTpm 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/ServerPerformStatusInput' 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}/update-kickstart-status: post: description: 执行操作UpdateKickstartStatus operationId: server_PerformUpdateKickstartStatus 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/ServerUpdateKickstartStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformUpdateKickstartStatusOutput' summary: 执行操作UpdateKickstartStatus tags: - server /servers/{id}/update-sub-ips: post: description: 执行操作UpdateSubIps operationId: server_PerformUpdateSubIps 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/GuestUpdateSubIpsInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformUpdateSubIpsOutput' summary: 执行操作UpdateSubIps tags: - server /servers/{id}/upload-status: post: description: 执行操作UploadStatus operationId: server_PerformUploadStatus 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/HostUploadGuestStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformUploadStatusOutput' summary: 执行操作UploadStatus 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-convert-precheck: post: description: 执行操作BatchConvertPrecheck operationId: server_PerformBatchConvertPrecheck parameters: - in: body name: body schema: properties: server: $ref: '#/definitions/BatchConvertToKvmCheckInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformBatchConvertPrecheckOutput' summary: 执行操作BatchConvertPrecheck 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/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/statistics: get: description: 获取指定资源类的信息Statistics operationId: server_GetPropertyStatistics responses: "200": $ref: '#/responses/server_GetPropertyStatisticsOutput' summary: 获取指定资源类的信息Statistics tags: - server /servers/upload-status: post: description: 执行操作UploadStatus operationId: server_PerformUploadStatus 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/HostUploadGuestStatusInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/server_PerformUploadStatusOutput' summary: 执行操作UploadStatus tags: - server /serverskus: get: description: 列表 operationId: serversku_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/serversku_ListItemFilterOutput' summary: 主机套餐规格列表 tags: - serversku post: description: 新建 operationId: serversku_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count serversku: $ref: '#/definitions/ServerSkuCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/serversku_ValidateCreateDataOutput' summary: 新建 tags: - serversku /serverskus/{id}: delete: description: 删除 operationId: serversku_CustomizeDelete parameters: - description: The Id or Name of serversku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/serversku_CustomizeDeleteOutput' summary: 删除 tags: - serversku get: description: 获取详情 operationId: serversku_FetchCustomizeColumns parameters: - description: The Id or Name of serversku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/serversku_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - serversku put: description: 更新 operationId: serversku_ValidateUpdateData parameters: - description: The Id or Name of serversku in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: serversku: $ref: '#/definitions/ServerSkuUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/serversku_ValidateUpdateDataOutput' summary: 更新 tags: - serversku /serverskus/{id}/disable: post: description: 执行操作Disable operationId: serversku_PerformDisable parameters: - description: The Id or Name of serversku in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: serversku: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/serversku_PerformDisableOutput' summary: 禁用资源 tags: - serversku /serverskus/{id}/enable: post: description: 执行操作Enable operationId: serversku_PerformEnable parameters: - description: The Id or Name of serversku in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: serversku: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/serversku_PerformEnableOutput' summary: 启用资源 tags: - serversku /serverskus/{id}/metadata: get: description: 获取指定信息Metadata operationId: serversku_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of serversku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/serversku_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - serversku /serverskus/{id}/status: get: description: 获取指定信息Status operationId: serversku_GetDetailsStatus parameters: - description: The Id or Name of serversku in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/serversku_GetDetailsStatusOutput' summary: 获取资源状态 tags: - serversku /serverskus/instance-specs: get: description: 获取指定资源类的信息InstanceSpecs operationId: serversku_GetPropertyInstanceSpecs responses: "200": $ref: '#/responses/serversku_GetPropertyInstanceSpecsOutput' summary: 获取指定资源类的信息InstanceSpecs tags: - serversku /serverskus/sync-skus: post: description: 执行操作SyncSkus operationId: serversku_PerformSyncSkus parameters: - in: body name: body schema: properties: serversku: $ref: '#/definitions/SkuSyncInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/serversku_PerformSyncSkusOutput' summary: 执行操作SyncSkus tags: - serversku /serverskus/sync-tasks: get: description: 获取指定资源类的信息SyncTasks operationId: serversku_GetPropertySyncTasks parameters: - description: 异步任务ID in: query items: type: string name: task_ids type: array x-go-name: TaskIds responses: "200": $ref: '#/responses/serversku_GetPropertySyncTasksOutput' summary: 获取指定资源类的信息SyncTasks tags: - serversku /servicecatalogs: get: description: 列表 operationId: servicecatalog_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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/servicecatalog_ListItemFilterOutput' summary: 服务目录列表 tags: - servicecatalog post: description: 新建 operationId: servicecatalog_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count servicecatalog: $ref: '#/definitions/ServiceCatalogCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/servicecatalog_ValidateCreateDataOutput' summary: 新建 tags: - servicecatalog /servicecatalogs/{id}: delete: description: 删除 operationId: servicecatalog_CustomizeDelete parameters: - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/servicecatalog_CustomizeDeleteOutput' summary: 删除 tags: - servicecatalog get: description: 获取详情 operationId: servicecatalog_FetchCustomizeColumns parameters: - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/servicecatalog_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - servicecatalog put: description: 更新 operationId: servicecatalog_ValidateUpdateData parameters: - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: servicecatalog: $ref: '#/definitions/ServiceCatalogUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/servicecatalog_ValidateUpdateDataOutput' summary: 更新 tags: - servicecatalog /servicecatalogs/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: servicecatalog_PerformChangeOwner parameters: - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: servicecatalog: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/servicecatalog_PerformChangeOwnerOutput' summary: 更改项目 tags: - servicecatalog /servicecatalogs/{id}/deploy: post: description: 执行操作Deploy operationId: servicecatalog_PerformDeploy parameters: - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: servicecatalog: $ref: '#/definitions/ServiceCatalogDeploy' type: object x-go-name: Body responses: "200": $ref: '#/responses/servicecatalog_PerformDeployOutput' summary: 执行操作Deploy tags: - servicecatalog /servicecatalogs/{id}/metadata: get: description: 获取指定信息Metadata operationId: servicecatalog_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/servicecatalog_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - servicecatalog /servicecatalogs/{id}/private: post: description: 执行操作Private operationId: servicecatalog_PerformPrivate parameters: - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: servicecatalog: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/servicecatalog_PerformPrivateOutput' summary: 执行操作Private tags: - servicecatalog /servicecatalogs/{id}/public: post: description: 执行操作Public operationId: servicecatalog_PerformPublic parameters: - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: servicecatalog: $ref: '#/definitions/PerformPublicProjectInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/servicecatalog_PerformPublicOutput' summary: 执行操作Public tags: - servicecatalog /servicecatalogs/{id}/status: get: description: 获取指定信息Status operationId: servicecatalog_GetDetailsStatus parameters: - description: The Id or Name of servicecatalog in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/servicecatalog_GetDetailsStatusOutput' summary: 获取资源状态 tags: - servicecatalog /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: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats 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_resources: get: description: 列表 operationId: snapshot_policy_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats responses: "200": $ref: '#/responses/snapshot_policy_resource_ListItemFilterOutput' summary: 列表 tags: - snapshot_policy_resource post: description: 新建 operationId: snapshot_policy_resource_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count snapshot_policy_resource: $ref: '#/definitions/ResourceBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshot_policy_resource_ValidateCreateDataOutput' summary: 新建 tags: - snapshot_policy_resource /snapshot_policy_resources/{id}: delete: description: 删除 operationId: snapshot_policy_resource_CustomizeDelete parameters: - description: The Id or Name of snapshot_policy_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/snapshot_policy_resource_CustomizeDeleteOutput' summary: 删除 tags: - snapshot_policy_resource get: description: 获取详情 operationId: snapshot_policy_resource_FetchCustomizeColumns parameters: - description: The Id or Name of snapshot_policy_resource in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/snapshot_policy_resource_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - snapshot_policy_resource put: description: 更新 operationId: snapshot_policy_resource_ValidateUpdateData parameters: - description: The Id or Name of snapshot_policy_resource in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: snapshot_policy_resource: $ref: '#/definitions/ResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshot_policy_resource_ValidateUpdateDataOutput' summary: 更新 tags: - snapshot_policy_resource /snapshotpolicies: get: description: 列表 operationId: snapshotpolicy_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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 - in: query name: order_by_snapshot_count type: string x-go-name: OrderBySnapshotCount - description: 按类型过滤 example: disk, server in: query name: type type: string x-go-name: Type - in: query items: type: string name: resource_id type: array x-go-name: ResourceId responses: "200": $ref: '#/responses/snapshotpolicy_ListItemFilterOutput' summary: 快照策略列表 tags: - snapshotpolicy post: description: 新建 operationId: snapshotpolicy_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count snapshotpolicy: $ref: '#/definitions/SSnapshotPolicyCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshotpolicy_ValidateCreateDataOutput' summary: 创建自动快照策略 tags: - snapshotpolicy /snapshotpolicies/{id}: delete: description: 删除 operationId: snapshotpolicy_CustomizeDelete parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/snapshotpolicy_CustomizeDeleteOutput' summary: 删除 tags: - snapshotpolicy get: description: 获取详情 operationId: snapshotpolicy_FetchCustomizeColumns parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/snapshotpolicy_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - snapshotpolicy put: description: 更新 operationId: snapshotpolicy_ValidateUpdateData parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: snapshotpolicy: $ref: '#/definitions/SSnapshotPolicyUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshotpolicy_ValidateUpdateDataOutput' summary: 更新自动快照策略 tags: - snapshotpolicy /snapshotpolicies/{id}/bind-disks: post: description: 执行操作BindDisks operationId: snapshotpolicy_PerformBindDisks parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: snapshotpolicy: $ref: '#/definitions/SnapshotPolicyDisksInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshotpolicy_PerformBindDisksOutput' summary: 绑定磁盘 tags: - snapshotpolicy /snapshotpolicies/{id}/bind-resources: post: description: |- 目前仅支持绑定主机和磁盘 磁盘只能绑定一个快照策略，已绑定时报错 若磁盘所属主机已绑定主机快照策略，则磁盘不能再绑定快照策略 主机只能绑定一个快照策略，已绑定时报错 若主机下任意磁盘已绑定快照策略，则主机不能再绑定主机快照策略 operationId: snapshotpolicy_PerformBindResources parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: snapshotpolicy: $ref: '#/definitions/SnapshotPolicyResourcesInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshotpolicy_PerformBindResourcesOutput' summary: 绑定资源 tags: - snapshotpolicy /snapshotpolicies/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: snapshotpolicy_PerformChangeOwner parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: snapshotpolicy: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshotpolicy_PerformChangeOwnerOutput' summary: 更改项目 tags: - snapshotpolicy /snapshotpolicies/{id}/metadata: get: description: 获取指定信息Metadata operationId: snapshotpolicy_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/snapshotpolicy_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - snapshotpolicy /snapshotpolicies/{id}/status: get: description: 获取指定信息Status operationId: snapshotpolicy_GetDetailsStatus parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/snapshotpolicy_GetDetailsStatusOutput' summary: 获取资源状态 tags: - snapshotpolicy /snapshotpolicies/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: snapshotpolicy_PerformSyncstatus parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/snapshotpolicy_PerformSyncstatusOutput' summary: 同步快照策略状态 tags: - snapshotpolicy /snapshotpolicies/{id}/unbind-disks: post: description: 执行操作UnbindDisks operationId: snapshotpolicy_PerformUnbindDisks parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: snapshotpolicy: $ref: '#/definitions/SnapshotPolicyDisksInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshotpolicy_PerformUnbindDisksOutput' summary: 解绑磁盘 tags: - snapshotpolicy /snapshotpolicies/{id}/unbind-resources: post: description: 执行操作UnbindResources operationId: snapshotpolicy_PerformUnbindResources parameters: - description: The Id or Name of snapshotpolicy in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: snapshotpolicy: $ref: '#/definitions/SnapshotPolicyResourcesInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/snapshotpolicy_PerformUnbindResourcesOutput' summary: 解绑主机 tags: - snapshotpolicy /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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: 以host过滤 in: query name: storage_host_id type: string x-go-name: StorageHostId - 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: unused type: boolean x-go-name: Unused - description: 按存储过滤 in: query name: storage_id type: string x-go-name: StorageId - 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}/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: 更改项目 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}/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 /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 /sslcertificates: get: description: 列表 operationId: sslcertificate_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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: is_expired type: boolean x-go-name: IsExpired responses: "200": $ref: '#/responses/sslcertificate_ListItemFilterOutput' summary: SSLCertificate实例列表 tags: - sslcertificate post: description: 新建 operationId: sslcertificate_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count sslcertificate: $ref: '#/definitions/SSLCertificateCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/sslcertificate_ValidateCreateDataOutput' summary: 新建 tags: - sslcertificate /sslcertificates/{id}: delete: description: 删除 operationId: sslcertificate_CustomizeDelete parameters: - description: The Id or Name of sslcertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/sslcertificate_CustomizeDeleteOutput' summary: 删除证书 tags: - sslcertificate get: description: 获取详情 operationId: sslcertificate_FetchCustomizeColumns parameters: - description: The Id or Name of sslcertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/sslcertificate_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - sslcertificate put: description: 更新 operationId: sslcertificate_ValidateUpdateData parameters: - description: The Id or Name of sslcertificate in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: sslcertificate: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/sslcertificate_ValidateUpdateDataOutput' summary: 更新 tags: - sslcertificate /sslcertificates/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: sslcertificate_PerformChangeOwner parameters: - description: The Id or Name of sslcertificate in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: sslcertificate: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/sslcertificate_PerformChangeOwnerOutput' summary: 更改项目 tags: - sslcertificate /sslcertificates/{id}/metadata: get: description: 获取指定信息Metadata operationId: sslcertificate_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of sslcertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/sslcertificate_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - sslcertificate /sslcertificates/{id}/status: get: description: 获取指定信息Status operationId: sslcertificate_GetDetailsStatus parameters: - description: The Id or Name of sslcertificate in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/sslcertificate_GetDetailsStatusOutput' summary: 获取资源状态 tags: - sslcertificate /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: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - 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 - 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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源外部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 - 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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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 - description: filter by storage type in: query name: storage_type type: string x-go-name: StorageType 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}/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}/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-commit-bound: post: description: 执行操作SetCommitBound operationId: storage_PerformSetCommitBound 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/StorageSetCmtBoundInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/storage_PerformSetCommitBoundOutput' summary: 执行操作SetCommitBound 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-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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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}/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: 更改项目 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}/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 /tap_flows: get: description: 列表 operationId: 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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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/tap_flow_ListItemFilterOutput' summary: 列表 tags: - tap_flow post: description: 新建 operationId: tap_flow_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count tap_flow: $ref: '#/definitions/NetTapFlowCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/tap_flow_ValidateCreateDataOutput' summary: 新建 tags: - tap_flow /tap_flows/{id}: delete: description: 删除 operationId: tap_flow_CustomizeDelete parameters: - description: The Id or Name of tap_flow in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/tap_flow_CustomizeDeleteOutput' summary: 删除 tags: - tap_flow get: description: 获取详情 operationId: tap_flow_FetchCustomizeColumns parameters: - description: The Id or Name of tap_flow in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/tap_flow_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - tap_flow put: description: 更新 operationId: tap_flow_ValidateUpdateData parameters: - description: The Id or Name of tap_flow in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: tap_flow: $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/tap_flow_ValidateUpdateDataOutput' summary: 更新 tags: - tap_flow /tap_flows/{id}/disable: post: description: 执行操作Disable operationId: tap_flow_PerformDisable parameters: - description: The Id or Name of tap_flow in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: tap_flow: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/tap_flow_PerformDisableOutput' summary: 禁用资源 tags: - tap_flow /tap_flows/{id}/enable: post: description: 执行操作Enable operationId: tap_flow_PerformEnable parameters: - description: The Id or Name of tap_flow in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: tap_flow: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/tap_flow_PerformEnableOutput' summary: 启用资源 tags: - tap_flow /tap_flows/{id}/metadata: get: description: 获取指定信息Metadata operationId: 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 tap_flow in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/tap_flow_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - tap_flow /tap_flows/{id}/status: get: description: 获取指定信息Status operationId: tap_flow_GetDetailsStatus parameters: - description: The Id or Name of tap_flow in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/tap_flow_GetDetailsStatusOutput' summary: 获取资源状态 tags: - tap_flow /tap_services: get: description: 列表 operationId: 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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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/tap_service_ListItemFilterOutput' summary: 列表 tags: - tap_service post: description: 新建 operationId: tap_service_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count tap_service: $ref: '#/definitions/NetTapServiceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/tap_service_ValidateCreateDataOutput' summary: 新建 tags: - tap_service /tap_services/{id}: delete: description: 删除 operationId: tap_service_CustomizeDelete parameters: - description: The Id or Name of tap_service in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/tap_service_CustomizeDeleteOutput' summary: 删除 tags: - tap_service get: description: 获取详情 operationId: tap_service_FetchCustomizeColumns parameters: - description: The Id or Name of tap_service in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/tap_service_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - tap_service put: description: 更新 operationId: tap_service_ValidateUpdateData parameters: - description: The Id or Name of tap_service in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: tap_service: $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/tap_service_ValidateUpdateDataOutput' summary: 更新 tags: - tap_service /tap_services/{id}/disable: post: description: 执行操作Disable operationId: tap_service_PerformDisable parameters: - description: The Id or Name of tap_service in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: tap_service: $ref: '#/definitions/PerformDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/tap_service_PerformDisableOutput' summary: 执行操作Disable tags: - tap_service /tap_services/{id}/enable: post: description: 执行操作Enable operationId: tap_service_PerformEnable parameters: - description: The Id or Name of tap_service in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: tap_service: $ref: '#/definitions/PerformEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/tap_service_PerformEnableOutput' summary: 执行操作Enable tags: - tap_service /tap_services/{id}/metadata: get: description: 获取指定信息Metadata operationId: 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 tap_service in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/tap_service_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - tap_service /tap_services/{id}/status: get: description: 获取指定信息Status operationId: tap_service_GetDetailsStatus parameters: - description: The Id or Name of tap_service in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/tap_service_GetDetailsStatusOutput' summary: 获取资源状态 tags: - tap_service /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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: peer_vpc_id type: string x-go-name: PeerVpcId 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}/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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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}/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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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}/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}/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 /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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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_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}/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}/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 /waf_regexsets: get: description: 列表 operationId: waf_regexset_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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_regexset_ListItemFilterOutput' summary: 列出WAF RegexSets tags: - waf_regexset post: description: 新建 operationId: waf_regexset_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count waf_regexset: $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/waf_regexset_ValidateCreateDataOutput' summary: 新建 tags: - waf_regexset /waf_regexsets/{id}: delete: description: 删除 operationId: waf_regexset_CustomizeDelete parameters: - description: The Id or Name of waf_regexset in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/waf_regexset_CustomizeDeleteOutput' summary: 删除 tags: - waf_regexset get: description: 获取详情 operationId: waf_regexset_FetchCustomizeColumns parameters: - description: The Id or Name of waf_regexset in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/waf_regexset_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - waf_regexset put: description: 更新 operationId: waf_regexset_ValidateUpdateData parameters: - description: The Id or Name of waf_regexset in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: waf_regexset: $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/waf_regexset_ValidateUpdateDataOutput' summary: 更新 tags: - waf_regexset /waf_regexsets/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: waf_regexset_PerformChangeOwner parameters: - description: The Id or Name of waf_regexset in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: waf_regexset: $ref: '#/definitions/PerformChangeDomainOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/waf_regexset_PerformChangeOwnerOutput' summary: 执行操作ChangeOwner tags: - waf_regexset /waf_regexsets/{id}/metadata: get: description: 获取指定信息Metadata operationId: waf_regexset_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: 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_regexset in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/waf_regexset_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - waf_regexset /waf_regexsets/{id}/private: post: description: 执行操作Private operationId: waf_regexset_PerformPrivate parameters: - description: The Id or Name of waf_regexset in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: waf_regexset: $ref: '#/definitions/PerformPrivateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/waf_regexset_PerformPrivateOutput' summary: 执行操作Private tags: - waf_regexset /waf_regexsets/{id}/public: post: description: 执行操作Public operationId: waf_regexset_PerformPublic parameters: - description: The Id or Name of waf_regexset in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: waf_regexset: $ref: '#/definitions/PerformPublicDomainInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/waf_regexset_PerformPublicOutput' summary: 执行操作Public tags: - waf_regexset /waf_regexsets/{id}/status: get: description: 获取指定信息Status operationId: waf_regexset_GetDetailsStatus parameters: - description: The Id or Name of waf_regexset in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/waf_regexset_GetDetailsStatusOutput' summary: 获取资源状态 tags: - waf_regexset /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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_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}/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}/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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats 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_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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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: 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 - in: query name: type type: string x-go-name: Type 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}/disable: post: description: 执行操作Disable operationId: waf_rule_PerformDisable 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/WafRuleDisableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/waf_rule_PerformDisableOutput' summary: 禁用 tags: - waf_rule /waf_rules/{id}/enable: post: description: 执行操作Enable operationId: waf_rule_PerformEnable 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/WafRuleEnableInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/waf_rule_PerformEnableOutput' summary: 启用 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}/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 /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 /webappenvironments: get: description: 列表 operationId: webappenvironment_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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: app_id type: string x-go-name: AppId - in: query name: instance_type type: string x-go-name: InstanceType responses: "200": $ref: '#/responses/webappenvironment_ListItemFilterOutput' summary: 列表 tags: - webappenvironment post: description: 新建 operationId: webappenvironment_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count webappenvironment: $ref: '#/definitions/VirtualResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/webappenvironment_ValidateCreateDataOutput' summary: 新建 tags: - webappenvironment /webappenvironments/{id}: delete: description: 删除 operationId: webappenvironment_CustomizeDelete parameters: - description: The Id or Name of webappenvironment in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webappenvironment_CustomizeDeleteOutput' summary: 删除 tags: - webappenvironment get: description: 获取详情 operationId: webappenvironment_FetchCustomizeColumns parameters: - description: The Id or Name of webappenvironment in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webappenvironment_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - webappenvironment put: description: 更新 operationId: webappenvironment_ValidateUpdateData parameters: - description: The Id or Name of webappenvironment in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: webappenvironment: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/webappenvironment_ValidateUpdateDataOutput' summary: 更新 tags: - webappenvironment /webappenvironments/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: webappenvironment_PerformChangeOwner parameters: - description: The Id or Name of webappenvironment in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: webappenvironment: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/webappenvironment_PerformChangeOwnerOutput' summary: 更改项目 tags: - webappenvironment /webappenvironments/{id}/metadata: get: description: 获取指定信息Metadata operationId: webappenvironment_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of webappenvironment in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webappenvironment_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - webappenvironment /webappenvironments/{id}/status: get: description: 获取指定信息Status operationId: webappenvironment_GetDetailsStatus parameters: - description: The Id or Name of webappenvironment in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webappenvironment_GetDetailsStatusOutput' summary: 获取资源状态 tags: - webappenvironment /webapps: get: description: 列表 operationId: webapp_ListItemFilter parameters: - default: 20 description: 查询限制量 format: int64 in: query name: limit type: integer x-go-name: Limit - default: 0 description: 查询偏移量 format: int64 in: query name: offset type: integer x-go-name: Offset - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 in: query items: type: string name: order_by type: array x-go-name: OrderBy - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 example: desc|asc in: query name: order type: string x-go-name: Order - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 in: query name: details type: boolean x-go-name: Details - description: 模糊搜索所有字段 in: query name: search type: string x-go-name: Search - description: |- 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') 支持的操作符如下： 操作符 | 参数个数 | 举例 | 说明 | ---------------|----------|------------------------------------------------|-----------------------------| in | > 0 | name.in("test", "good") | 在给定数组中 | notin | > 0 | name.notin('test') | 不在给定数组中 | between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | equals | > 0 | name.equals('test') | 等于任意一个给定值 | notequals | 1 | name.notequals('test') | 不等于给定值 | isnull | 0 | name.isnull() | 值为SQL的NULL | isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | isempty | 0 | name.isempty('test') | 值为空字符串 | isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | in: query items: type: string name: filter type: array x-go-name: Filter - description: |- 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， 和其他表关联的语法如下： joint_resources.related_key(origin_key).filter_col.filter_ops(values) 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 举例： guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') in: query items: type: string name: joint_filter type: array x-go-name: JointFilter - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 in: query name: filter_any type: boolean x-go-name: FilterAny - description: 返回结果只包含指定的字段 in: query items: type: string name: field type: array x-go-name: Field - description: 用于数据导出，指定导出的数据字段 in: query name: export_keys type: string x-go-name: ExportKeys - description: 返回结果携带delete_fail_reason和update_fail_reason字段 in: query name: show_fail_reason type: boolean x-go-name: ShowFailReason - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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/webapp_ListItemFilterOutput' summary: 列表 tags: - webapp post: description: 新建 operationId: webapp_ValidateCreateData parameters: - in: body name: body schema: properties: count: default: 1 format: int64 type: integer x-go-name: Count webapp: $ref: '#/definitions/VirtualResourceCreateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/webapp_ValidateCreateDataOutput' summary: 新建 tags: - webapp /webapps/{id}: delete: description: 删除 operationId: webapp_CustomizeDelete parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_CustomizeDeleteOutput' summary: 删除 tags: - webapp get: description: 获取详情 operationId: webapp_FetchCustomizeColumns parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_FetchCustomizeColumnsOutput' summary: 获取详情 tags: - webapp put: description: 更新 operationId: webapp_ValidateUpdateData parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: webapp: $ref: '#/definitions/VirtualResourceBaseUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/webapp_ValidateUpdateDataOutput' summary: 更新 tags: - webapp /webapps/{id}/backups: get: description: 获取指定信息Backups operationId: webapp_GetDetailsBackups parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_GetDetailsBackupsOutput' summary: 获取备份列表 tags: - webapp /webapps/{id}/certificates: get: description: 获取指定信息Certificates operationId: webapp_GetDetailsCertificates parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_GetDetailsCertificatesOutput' summary: 获取证书列表 tags: - webapp /webapps/{id}/change-owner: post: description: 执行操作ChangeOwner operationId: webapp_PerformChangeOwner parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: webapp: $ref: '#/definitions/PerformChangeProjectOwnerInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/webapp_PerformChangeOwnerOutput' summary: 更改项目 tags: - webapp /webapps/{id}/custom-domains: get: description: 获取指定信息CustomDomains operationId: webapp_GetDetailsCustomDomains parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_GetDetailsCustomDomainsOutput' summary: 获取自定义域列表 tags: - webapp /webapps/{id}/hybird-connections: get: description: 获取指定信息HybirdConnections operationId: webapp_GetDetailsHybirdConnections parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_GetDetailsHybirdConnectionsOutput' summary: 获取混合连接 tags: - webapp /webapps/{id}/metadata: get: description: 获取指定信息Metadata operationId: webapp_GetDetailsMetadata parameters: - description: |- 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 标签分为 类型 | 说明 | ----------|---------------------------------------------| 系统标签 | 平台定义的标签 | 用户标签 | key以user:为前缀，用户自定义标签 | 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | in: query items: type: string name: field type: array x-go-name: Field - description: 按标签前缀过滤 in: query name: prefix type: string x-go-name: Prefix - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_GetDetailsMetadataOutput' summary: 获取资源标签（元数据） tags: - webapp /webapps/{id}/remote-update: post: description: 执行操作RemoteUpdate operationId: webapp_PerformRemoteUpdate parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id - in: body name: body schema: properties: webapp: $ref: '#/definitions/MongoDBRemoteUpdateInput' type: object x-go-name: Body responses: "200": $ref: '#/responses/webapp_PerformRemoteUpdateOutput' summary: 执行操作RemoteUpdate tags: - webapp /webapps/{id}/status: get: description: 获取指定信息Status operationId: webapp_GetDetailsStatus parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_GetDetailsStatusOutput' summary: 获取资源状态 tags: - webapp /webapps/{id}/syncstatus: post: description: 执行操作Syncstatus operationId: webapp_PerformSyncstatus parameters: - description: The Id or Name of webapp in: path name: id required: true type: string x-go-name: Id responses: "200": $ref: '#/responses/webapp_PerformSyncstatusOutput' summary: 执行操作Syncstatus tags: - webapp /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源是否共享过滤列表 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 - 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}/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}/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 /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 /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 - description: 是否返回状态统计信息，默认为False in: query name: summary_stats type: boolean x-go-name: SummaryStats - $ref: '#/definitions/TTagSet' description: 通过标签过滤（包含这些标签） in: query name: tags x-go-name: Tags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还包含这些标签，OR的关系） in: query name: obj_tags x-go-name: ObjTags - $ref: '#/definitions/TTagSet' description: 通过标签过滤（不包含这些标签） in: query name: no_tags x-go-name: NoTags - $ref: '#/definitions/TTagSetList' description: 通过一组标签过滤（还不包含这些标签，AND的关系） in: query name: no_obj_tags x-go-name: NoObjTags - description: 通过标签排序 in: query name: order_by_tag type: string x-go-name: OrderByTag - description: |- deprecated 返回资源的标签不包含用户标签 in: query name: without_user_meta type: boolean x-go-name: WithoutUserMeta - description: 返回包含用户标签的资源 in: query name: with_user_meta type: boolean x-go-name: WithUserMeta - description: 返回包含外部标签的资源 in: query name: with_cloud_meta type: boolean x-go-name: WithCloudMeta - description: 返回包含任意标签的资源 in: query name: with_any_meta type: boolean x-go-name: WithAnyMeta - description: 返回列表数据中包含资源的标签数据（Metadata） in: query name: with_meta type: boolean x-go-name: WithMeta - description: 显示所有的资源，包括模拟的资源 in: query name: show_emulated type: boolean x-go-name: ShowEmulated - description: 以资源ID过滤列表 in: query items: type: string name: id type: array x-go-name: Ids - description: 以资源名称过滤列表 in: query items: type: string name: name type: array x-go-name: Names - description: 以资源的状态过滤列表 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 - 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: order_by_wires type: string x-go-name: OrderByWires - in: query name: order_by_hosts type: string x-go-name: OrderByHosts - in: query name: order_by_hosts_enabled type: string x-go-name: OrderByHostsEnabled - in: query name: order_by_baremetals type: string x-go-name: OrderByBaremetals - in: query name: order_by_baremetals_enabled type: string x-go-name: OrderByBaremetalsEnabled 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}/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}/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-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}/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 produces: - application/json responses: 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_GetDetailsMetadataOutput: 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_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_PerformPrivateOutput: description: "" access_group_PerformPublicOutput: 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_GetDetailsMetadataOutput: 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_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_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 ai_gateway_CustomizeDeleteOutput: description: "" schema: properties: ai_gateway: $ref: '#/definitions/AiGatewayDetails' type: object ai_gateway_FetchCustomizeColumnsOutput: description: "" schema: properties: ai_gateway: $ref: '#/definitions/AiGatewayDetails' type: object ai_gateway_GetDetailsMetadataOutput: description: "" schema: properties: ai_gateway: additionalProperties: type: string type: object x-go-name: Output type: object ai_gateway_GetDetailsStatusOutput: description: "" schema: properties: ai_gateway: $ref: '#/definitions/GetDetailsStatusOutput' type: object ai_gateway_ListItemFilterOutput: description: "" schema: properties: ai_gateways: items: $ref: '#/definitions/AiGatewayDetails' 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 ai_gateway_PerformChangeConfigOutput: description: "" ai_gateway_PerformChangeOwnerOutput: description: "" ai_gateway_PerformSyncstatusOutput: description: "" ai_gateway_ValidateCreateDataOutput: description: "" schema: properties: ai_gateway: $ref: '#/definitions/AiGatewayDetails' type: object ai_gateway_ValidateUpdateDataOutput: description: "" schema: properties: ai_gateway: $ref: '#/definitions/AiGatewayDetails' type: object backupstorage_CustomizeDeleteOutput: description: "" schema: properties: backupstorage: $ref: '#/definitions/BackupStorageDetails' type: object backupstorage_FetchCustomizeColumnsOutput: description: "" schema: properties: backupstorage: $ref: '#/definitions/BackupStorageDetails' type: object backupstorage_GetDetailsMetadataOutput: description: "" schema: properties: backupstorage: additionalProperties: type: string type: object x-go-name: Output type: object backupstorage_GetDetailsStatusOutput: description: "" schema: properties: backupstorage: $ref: '#/definitions/GetDetailsStatusOutput' type: object backupstorage_ListItemFilterOutput: description: "" schema: properties: backupstorages: 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 backupstorage_PerformChangeOwnerOutput: description: "" backupstorage_PerformDisableOutput: description: "" backupstorage_PerformEnableOutput: description: "" backupstorage_PerformPrivateOutput: description: "" backupstorage_PerformPublicOutput: description: "" backupstorage_PerformSyncstatusOutput: description: "" backupstorage_ValidateCreateDataOutput: description: "" schema: properties: backupstorage: $ref: '#/definitions/BackupStorageDetails' type: object backupstorage_ValidateUpdateDataOutput: description: "" schema: properties: backupstorage: $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_GetDetailsMetadataOutput: description: "" schema: properties: baremetalagent: additionalProperties: type: string type: object x-go-name: Output type: object 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_PerformDisableImageCacheOutput: description: "" baremetalagent_PerformDisableOutput: description: "" baremetalagent_PerformEnableImageCacheOutput: description: "" baremetalagent_PerformEnableOutput: description: "" baremetalagent_PerformOfflineOutput: description: "" baremetalagent_PerformOnlineOutput: 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/VirtualResourceDetails' type: object billing_resource_check_FetchCustomizeColumnsOutput: description: "" schema: properties: billing_resource_check: $ref: '#/definitions/VirtualResourceDetails' type: object billing_resource_check_GetDetailsMetadataOutput: description: "" schema: properties: billing_resource_check: additionalProperties: type: string type: object x-go-name: Output type: object billing_resource_check_GetDetailsStatusOutput: description: "" schema: properties: billing_resource_check: $ref: '#/definitions/GetDetailsStatusOutput' type: object billing_resource_check_ListItemFilterOutput: description: "" schema: properties: billing_resource_checks: 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 billing_resource_check_PerformChangeOwnerOutput: description: "" billing_resource_check_PerformCheckOutput: description: "" billing_resource_check_ValidateCreateDataOutput: description: "" schema: properties: billing_resource_check: $ref: '#/definitions/VirtualResourceDetails' type: object billing_resource_check_ValidateUpdateDataOutput: description: "" schema: properties: billing_resource_check: $ref: '#/definitions/VirtualResourceDetails' 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_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_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_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_PerformChangeOwnerOutput: description: "" bucket_PerformDeleteCorsOutput: description: "" bucket_PerformDeleteOutput: description: "" bucket_PerformDeletePolicyOutput: description: "" bucket_PerformDeleteWebsiteOutput: description: "" bucket_PerformLimitOutput: description: "" bucket_PerformMakedirOutput: description: "" bucket_PerformMetadataOutput: description: "" bucket_PerformPrivateOutput: description: "" bucket_PerformPublicOutput: description: "" bucket_PerformSetCorsOutput: description: "" bucket_PerformSetPolicyOutput: description: "" bucket_PerformSetRefererOutput: description: "" bucket_PerformSetWebsiteOutput: description: "" bucket_PerformSyncOutput: description: "" bucket_PerformSyncstatusOutput: description: "" bucket_PerformTempUrlOutput: description: "" schema: properties: bucket: $ref: '#/definitions/BucketPerformTempUrlOutput' type: object 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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" cachedimage_PerformPrivateOutput: description: "" cachedimage_PerformPublicOutput: description: "" cachedimage_PerformRefreshOutput: description: "" cachedimage_PerformUncacheImageOutput: 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_GetDetailsCustomHostnamesOutput: description: "" schema: properties: cdn_domain: $ref: '#/definitions/CDNCustomHostnameOutput' type: object cdn_domain_GetDetailsMetadataOutput: 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_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_PerformAddCustomHostnameOutput: description: "" cdn_domain_PerformChangeConfigOutput: description: "" cdn_domain_PerformChangeOwnerOutput: description: "" cdn_domain_PerformClearCacheOutput: description: "" cdn_domain_PerformDeleteCustomHostnameOutput: description: "" cdn_domain_PerformDisableOutput: description: "" cdn_domain_PerformEnableOutput: description: "" cdn_domain_PerformRemoteUpdateOutput: description: "" cdn_domain_PerformSyncstatusOutput: 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 cloud_kube_cluster_CustomizeDeleteOutput: description: "" schema: properties: cloud_kube_cluster: $ref: '#/definitions/KubeClusterDetails' type: object cloud_kube_cluster_FetchCustomizeColumnsOutput: description: "" schema: properties: cloud_kube_cluster: $ref: '#/definitions/KubeClusterDetails' type: object cloud_kube_cluster_GetDetailsKubeconfigOutput: description: "" schema: properties: cloud_kube_cluster: $ref: '#/definitions/SKubeconfig' type: object cloud_kube_cluster_GetDetailsMetadataOutput: description: "" schema: properties: cloud_kube_cluster: additionalProperties: type: string type: object x-go-name: Output type: object cloud_kube_cluster_GetDetailsStatusOutput: description: "" schema: properties: cloud_kube_cluster: $ref: '#/definitions/GetDetailsStatusOutput' type: object cloud_kube_cluster_ListItemFilterOutput: description: "" schema: properties: cloud_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 cloud_kube_cluster_PerformChangeOwnerOutput: description: "" cloud_kube_cluster_PerformDisableOutput: description: "" cloud_kube_cluster_PerformEnableOutput: description: "" cloud_kube_cluster_PerformPrivateOutput: description: "" cloud_kube_cluster_PerformPublicOutput: description: "" cloud_kube_cluster_PerformSyncstatusOutput: description: "" cloud_kube_cluster_ValidateCreateDataOutput: description: "" schema: properties: cloud_kube_cluster: $ref: '#/definitions/KubeClusterDetails' type: object cloud_kube_cluster_ValidateUpdateDataOutput: description: "" schema: properties: cloud_kube_cluster: $ref: '#/definitions/KubeClusterDetails' type: object cloud_kube_node_CustomizeDeleteOutput: description: "" schema: properties: cloud_kube_node: $ref: '#/definitions/KubeNodeDetails' type: object cloud_kube_node_FetchCustomizeColumnsOutput: description: "" schema: properties: cloud_kube_node: $ref: '#/definitions/KubeNodeDetails' type: object cloud_kube_node_GetDetailsMetadataOutput: description: "" schema: properties: cloud_kube_node: additionalProperties: type: string type: object x-go-name: Output type: object cloud_kube_node_GetDetailsStatusOutput: description: "" schema: properties: cloud_kube_node: $ref: '#/definitions/GetDetailsStatusOutput' type: object cloud_kube_node_ListItemFilterOutput: description: "" schema: properties: cloud_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 cloud_kube_node_ValidateCreateDataOutput: description: "" schema: properties: cloud_kube_node: $ref: '#/definitions/KubeNodeDetails' type: object cloud_kube_node_ValidateUpdateDataOutput: description: "" schema: properties: cloud_kube_node: $ref: '#/definitions/KubeNodeDetails' type: object cloud_kube_node_pool_CustomizeDeleteOutput: description: "" schema: properties: cloud_kube_node_pool: $ref: '#/definitions/KubeNodePoolDetails' type: object cloud_kube_node_pool_FetchCustomizeColumnsOutput: description: "" schema: properties: cloud_kube_node_pool: $ref: '#/definitions/KubeNodePoolDetails' type: object cloud_kube_node_pool_GetDetailsMetadataOutput: description: "" schema: properties: cloud_kube_node_pool: additionalProperties: type: string type: object x-go-name: Output type: object cloud_kube_node_pool_GetDetailsStatusOutput: description: "" schema: properties: cloud_kube_node_pool: $ref: '#/definitions/GetDetailsStatusOutput' type: object cloud_kube_node_pool_ListItemFilterOutput: description: "" schema: properties: cloud_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 cloud_kube_node_pool_PerformSyncstatusOutput: description: "" cloud_kube_node_pool_ValidateCreateDataOutput: description: "" schema: properties: cloud_kube_node_pool: $ref: '#/definitions/KubeNodePoolDetails' type: object cloud_kube_node_pool_ValidateUpdateDataOutput: description: "" schema: properties: cloud_kube_node_pool: $ref: '#/definitions/KubeNodePoolDetails' 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_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_GetDetailsSamlOutput: description: "" cloudaccount_GetDetailsStatusOutput: description: "" schema: properties: cloudaccount: $ref: '#/definitions/GetDetailsStatusOutput' type: object 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_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_PerformShareModeOutput: 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 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_GetDetailsClircOutput: description: "" cloudprovider_GetDetailsMetadataOutput: 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_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_PerformDisableOutput: description: "" cloudprovider_PerformEnableOutput: description: "" cloudprovider_PerformProjectMappingOutput: description: "" cloudprovider_PerformSetSchedtagOutput: description: "" cloudprovider_PerformSetSyncingOutput: 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_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_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_GetDetailsDiskCapabilityOutput: description: "" cloudregion_GetDetailsMetadataOutput: 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_GetPropertySyncTasksOutput: 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_PerformDefaultVpcOutput: description: "" cloudregion_PerformDisableOutput: description: "" cloudregion_PerformEnableOutput: description: "" cloudregion_PerformPurgeOutput: description: "" cloudregion_PerformSetSchedtagOutput: 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_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_GetDetailsStatusOutput: description: "" schema: properties: container: $ref: '#/definitions/GetDetailsStatusOutput' type: object 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_PerformAddVolumeMountPostOverlayOutput: description: "" container_PerformChangeOwnerOutput: description: "" container_PerformCommitOutput: description: "" schema: properties: container: $ref: '#/definitions/ContainerCommitOutput' type: object container_PerformExecSyncOutput: description: "" container_PerformRemoveVolumeMountPostOverlayOutput: description: "" container_PerformRestartOutput: description: "" container_PerformSaveVolumeMountImageOutput: description: "" schema: properties: container: $ref: '#/definitions/ContainerSaveVolumeMountToImageInput' type: object container_PerformSetResourcesLimitOutput: description: "" container_PerformStartOutput: description: "" container_PerformStatusOutput: description: "" container_PerformStopOutput: description: "" container_PerformSyncstatusOutput: description: "" container_ValidateCreateDataOutput: description: "" schema: properties: container: $ref: '#/definitions/VirtualResourceDetails' type: object container_ValidateUpdateDataOutput: description: "" schema: properties: container: $ref: '#/definitions/VirtualResourceDetails' type: object dbinstance_CustomizeDeleteOutput: description: "" schema: properties: dbinstance: $ref: '#/definitions/DBInstanceDetails' type: object dbinstance_FetchCustomizeColumnsOutput: description: "" schema: properties: dbinstance: $ref: '#/definitions/DBInstanceDetails' type: object dbinstance_GetDetailsMetadataOutput: description: "" schema: properties: dbinstance: additionalProperties: type: string type: object x-go-name: Output type: object dbinstance_GetDetailsStatusOutput: description: "" schema: properties: dbinstance: $ref: '#/definitions/GetDetailsStatusOutput' type: object dbinstance_ListItemFilterOutput: description: "" schema: properties: dbinstances: 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 dbinstance_PerformCancelExpireOutput: description: "" dbinstance_PerformChangeConfigOutput: description: "" dbinstance_PerformChangeOwnerOutput: description: "" dbinstance_PerformPostpaidExpireOutput: description: "" dbinstance_PerformPublicConnectionOutput: description: "" dbinstance_PerformPurgeOutput: description: "" dbinstance_PerformRebootOutput: description: "" dbinstance_PerformRecoveryOutput: description: "" dbinstance_PerformRemoteUpdateOutput: description: "" dbinstance_PerformRenewOutput: description: "" dbinstance_PerformSetAutoRenewOutput: description: "" dbinstance_PerformSetSecgroupOutput: description: "" dbinstance_PerformSyncOutput: description: "" dbinstance_PerformSyncStatusOutput: description: "" dbinstance_PerformSyncstatusOutput: description: "" dbinstance_ValidateCreateDataOutput: description: "" schema: properties: dbinstance: $ref: '#/definitions/DBInstanceDetails' type: object dbinstance_ValidateUpdateDataOutput: description: "" schema: properties: dbinstance: $ref: '#/definitions/DBInstanceDetails' type: object dbinstance_sku_CustomizeDeleteOutput: description: "" schema: properties: dbinstance_sku: $ref: '#/definitions/DBInstanceSkuDetails' type: object dbinstance_sku_FetchCustomizeColumnsOutput: description: "" schema: properties: dbinstance_sku: $ref: '#/definitions/DBInstanceSkuDetails' type: object dbinstance_sku_GetDetailsMetadataOutput: description: "" schema: properties: dbinstance_sku: additionalProperties: type: string type: object x-go-name: Output type: object dbinstance_sku_GetDetailsStatusOutput: description: "" schema: properties: dbinstance_sku: $ref: '#/definitions/GetDetailsStatusOutput' type: object dbinstance_sku_GetPropertyInstanceSpecsOutput: description: "" dbinstance_sku_GetPropertySyncTasksOutput: description: "" dbinstance_sku_ListItemFilterOutput: description: "" schema: properties: dbinstance_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 dbinstance_sku_PerformDisableOutput: description: "" dbinstance_sku_PerformEnableOutput: description: "" dbinstance_sku_PerformSyncSkusOutput: description: "" dbinstance_sku_ValidateCreateDataOutput: description: "" schema: properties: dbinstance_sku: $ref: '#/definitions/DBInstanceSkuDetails' type: object dbinstance_sku_ValidateUpdateDataOutput: description: "" schema: properties: dbinstance_sku: $ref: '#/definitions/DBInstanceSkuDetails' type: object dbinstanceaccount_CustomizeDeleteOutput: description: "" schema: properties: dbinstanceaccount: $ref: '#/definitions/DBInstanceAccountDetails' type: object dbinstanceaccount_FetchCustomizeColumnsOutput: description: "" schema: properties: dbinstanceaccount: $ref: '#/definitions/DBInstanceAccountDetails' type: object dbinstanceaccount_GetDetailsMetadataOutput: description: "" schema: properties: dbinstanceaccount: additionalProperties: type: string type: object x-go-name: Output type: object dbinstanceaccount_GetDetailsStatusOutput: description: "" schema: properties: dbinstanceaccount: $ref: '#/definitions/GetDetailsStatusOutput' type: object dbinstanceaccount_ListItemFilterOutput: description: "" schema: properties: dbinstanceaccounts: 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 dbinstanceaccount_PerformGrantPrivilegeOutput: description: "" dbinstanceaccount_PerformResetPasswordOutput: description: "" dbinstanceaccount_PerformRevokePrivilegeOutput: description: "" dbinstanceaccount_PerformSetPrivilegesOutput: description: "" dbinstanceaccount_ValidateCreateDataOutput: description: "" schema: properties: dbinstanceaccount: $ref: '#/definitions/DBInstanceAccountDetails' type: object dbinstanceaccount_ValidateUpdateDataOutput: description: "" schema: properties: dbinstanceaccount: $ref: '#/definitions/DBInstanceAccountDetails' type: object dbinstancebackup_CustomizeDeleteOutput: description: "" schema: properties: dbinstancebackup: $ref: '#/definitions/DBInstanceBackupDetails' type: object dbinstancebackup_FetchCustomizeColumnsOutput: description: "" schema: properties: dbinstancebackup: $ref: '#/definitions/DBInstanceBackupDetails' type: object dbinstancebackup_GetDetailsMetadataOutput: description: "" schema: properties: dbinstancebackup: additionalProperties: type: string type: object x-go-name: Output type: object dbinstancebackup_GetDetailsStatusOutput: description: "" schema: properties: dbinstancebackup: $ref: '#/definitions/GetDetailsStatusOutput' type: object dbinstancebackup_ListItemFilterOutput: description: "" schema: properties: dbinstancebackups: 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 dbinstancebackup_PerformChangeOwnerOutput: description: "" dbinstancebackup_PerformSyncstatusOutput: description: "" dbinstancebackup_ValidateCreateDataOutput: description: "" schema: properties: dbinstancebackup: $ref: '#/definitions/DBInstanceBackupDetails' type: object dbinstancebackup_ValidateUpdateDataOutput: description: "" schema: properties: dbinstancebackup: $ref: '#/definitions/DBInstanceBackupDetails' type: object dbinstancedatabase_CustomizeDeleteOutput: description: "" schema: properties: dbinstancedatabase: $ref: '#/definitions/DBInstancedatabaseDetails' type: object dbinstancedatabase_FetchCustomizeColumnsOutput: description: "" schema: properties: dbinstancedatabase: $ref: '#/definitions/DBInstancedatabaseDetails' type: object dbinstancedatabase_GetDetailsMetadataOutput: description: "" schema: properties: dbinstancedatabase: additionalProperties: type: string type: object x-go-name: Output type: object dbinstancedatabase_GetDetailsStatusOutput: description: "" schema: properties: dbinstancedatabase: $ref: '#/definitions/GetDetailsStatusOutput' type: object dbinstancedatabase_ListItemFilterOutput: description: "" schema: properties: dbinstancedatabases: 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 dbinstancedatabase_ValidateCreateDataOutput: description: "" schema: properties: dbinstancedatabase: $ref: '#/definitions/DBInstancedatabaseDetails' type: object dbinstancedatabase_ValidateUpdateDataOutput: description: "" schema: properties: dbinstancedatabase: $ref: '#/definitions/DBInstancedatabaseDetails' type: object dbinstanceparameter_CustomizeDeleteOutput: description: "" schema: properties: dbinstanceparameter: $ref: '#/definitions/DBInstanceparameterDetails' type: object dbinstanceparameter_FetchCustomizeColumnsOutput: description: "" schema: properties: dbinstanceparameter: $ref: '#/definitions/DBInstanceparameterDetails' type: object dbinstanceparameter_GetDetailsMetadataOutput: description: "" schema: properties: dbinstanceparameter: additionalProperties: type: string type: object x-go-name: Output type: object dbinstanceparameter_ListItemFilterOutput: description: "" schema: properties: dbinstanceparameters: 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 dbinstanceparameter_ValidateCreateDataOutput: description: "" schema: properties: dbinstanceparameter: $ref: '#/definitions/DBInstanceparameterDetails' type: object dbinstanceparameter_ValidateUpdateDataOutput: description: "" schema: properties: dbinstanceparameter: $ref: '#/definitions/DBInstanceparameterDetails' type: object dbinstanceprivilege_CustomizeDeleteOutput: description: "" schema: properties: dbinstanceprivilege: $ref: '#/definitions/ResourceBaseDetails' type: object dbinstanceprivilege_FetchCustomizeColumnsOutput: description: "" schema: properties: dbinstanceprivilege: $ref: '#/definitions/ResourceBaseDetails' type: object dbinstanceprivilege_ListItemFilterOutput: description: "" schema: properties: dbinstanceprivileges: 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 dbinstanceprivilege_ValidateCreateDataOutput: description: "" schema: properties: dbinstanceprivilege: $ref: '#/definitions/ResourceBaseDetails' type: object dbinstanceprivilege_ValidateUpdateDataOutput: description: "" schema: properties: dbinstanceprivilege: $ref: '#/definitions/ResourceBaseDetails' 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_GetDetailsMetadataOutput: 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_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_PerformChangeBillingTypeOutput: description: "" disk_PerformChangeOwnerOutput: description: "" disk_PerformChangeStorageTypeOutput: description: "" disk_PerformDiskResetOutput: description: "" disk_PerformMigrateOutput: description: "" disk_PerformPurgeOutput: description: "" disk_PerformRebuildOutput: description: "" disk_PerformResizeOutput: description: "" disk_PerformSaveOutput: description: "" disk_PerformSetSnapshotpolicyOutput: description: "" disk_PerformSyncstatusOutput: description: "" disk_PerformUnbindSnapshotpolicyOutput: description: "" disk_ValidateCreateDataOutput: description: "" schema: properties: disk: $ref: '#/definitions/DiskDetails' type: object disk_ValidateUpdateDataOutput: description: "" schema: properties: disk: $ref: '#/definitions/DiskDetails' type: object diskbackup_CustomizeDeleteOutput: description: "" schema: properties: diskbackup: $ref: '#/definitions/DiskBackupDetails' type: object diskbackup_FetchCustomizeColumnsOutput: description: "" schema: properties: diskbackup: $ref: '#/definitions/DiskBackupDetails' type: object diskbackup_GetDetailsExportInfoOutput: description: "" schema: properties: diskbackup: $ref: '#/definitions/DiskBackupExportInfo' type: object diskbackup_GetDetailsMetadataOutput: description: "" schema: properties: diskbackup: additionalProperties: type: string type: object x-go-name: Output type: object diskbackup_GetDetailsStatusOutput: description: "" schema: properties: diskbackup: $ref: '#/definitions/GetDetailsStatusOutput' type: object diskbackup_ListItemFilterOutput: description: "" schema: properties: diskbackups: 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 diskbackup_PerformChangeOwnerOutput: description: "" diskbackup_PerformImportOutput: description: "" diskbackup_PerformRecoveryOutput: description: "" diskbackup_PerformSyncstatusOutput: description: "" diskbackup_ValidateCreateDataOutput: description: "" schema: properties: diskbackup: $ref: '#/definitions/DiskBackupDetails' type: object diskbackup_ValidateUpdateDataOutput: description: "" schema: properties: diskbackup: $ref: '#/definitions/DiskBackupDetails' 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_GetDetailsExportsOutput: description: "" dns_zone_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" dns_zone_PerformPrivateOutput: description: "" dns_zone_PerformPublicOutput: description: "" dns_zone_PerformPurgeOutput: description: "" dns_zone_PerformRemoveVpcsOutput: description: "" dns_zone_PerformSyncstatusOutput: 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 dnsrecord_CustomizeDeleteOutput: description: "" schema: properties: dnsrecord: $ref: '#/definitions/DnsRecordDetails' type: object dnsrecord_FetchCustomizeColumnsOutput: description: "" schema: properties: dnsrecord: $ref: '#/definitions/DnsRecordDetails' type: object dnsrecord_GetDetailsMetadataOutput: description: "" schema: properties: dnsrecord: additionalProperties: type: string type: object x-go-name: Output type: object dnsrecord_GetDetailsStatusOutput: description: "" schema: properties: dnsrecord: $ref: '#/definitions/GetDetailsStatusOutput' type: object dnsrecord_ListItemFilterOutput: description: "" schema: properties: dnsrecords: 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 dnsrecord_PerformDisableOutput: description: "" dnsrecord_PerformEnableOutput: description: "" dnsrecord_ValidateCreateDataOutput: description: "" schema: properties: dnsrecord: $ref: '#/definitions/DnsRecordDetails' type: object dnsrecord_ValidateUpdateDataOutput: description: "" schema: properties: dnsrecord: $ref: '#/definitions/DnsRecordDetails' 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_GetDetailsMetadataOutput: description: "" schema: properties: dynamicschedtag: additionalProperties: type: string type: object x-go-name: Output type: object 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_PerformEvaluateOutput: description: "" dynamicschedtag_ValidateCreateDataOutput: description: "" schema: properties: dynamicschedtag: $ref: '#/definitions/DynamicschedtagDetails' type: object dynamicschedtag_ValidateUpdateDataOutput: description: "" schema: properties: dynamicschedtag: $ref: '#/definitions/DynamicschedtagDetails' type: object eip_CustomizeDeleteOutput: description: "" schema: properties: eip: $ref: '#/definitions/ElasticipDetails' type: object eip_FetchCustomizeColumnsOutput: description: "" schema: properties: eip: $ref: '#/definitions/ElasticipDetails' type: object eip_GetDetailsMetadataOutput: description: "" schema: properties: eip: additionalProperties: type: string type: object x-go-name: Output type: object eip_GetDetailsStatusOutput: description: "" schema: properties: eip: $ref: '#/definitions/GetDetailsStatusOutput' type: object eip_ListItemFilterOutput: description: "" schema: properties: eips: 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 eip_PerformAssociateOutput: description: "" schema: properties: eip: $ref: '#/definitions/ElasticipAssociateInput' type: object eip_PerformChangeBandwidthOutput: description: "" eip_PerformChangeOwnerOutput: description: "" eip_PerformDissociateOutput: description: "" eip_PerformPurgeOutput: description: "" eip_PerformRemoteUpdateOutput: description: "" eip_PerformSyncOutput: description: "" eip_PerformSyncstatusOutput: description: "" eip_ValidateCreateDataOutput: description: "" schema: properties: eip: $ref: '#/definitions/ElasticipDetails' type: object eip_ValidateUpdateDataOutput: description: "" schema: properties: eip: $ref: '#/definitions/ElasticipDetails' 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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" elastic_search_PerformSyncstatusOutput: 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_GetDetailsLoginInfoOutput: description: "" elasticcache_GetDetailsMetadataOutput: 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_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_PerformCancelExpireOutput: description: "" elasticcache_PerformChangeOwnerOutput: description: "" elasticcache_PerformChangeSpecOutput: description: "" elasticcache_PerformFlushInstanceOutput: description: "" elasticcache_PerformPostpaidExpireOutput: description: "" elasticcache_PerformReleasePublicConnectionOutput: description: "" elasticcache_PerformRemoteUpdateOutput: description: "" elasticcache_PerformRenewOutput: description: "" elasticcache_PerformResetPasswordOutput: description: "" elasticcache_PerformRestartOutput: description: "" elasticcache_PerformRevokeSecgroupOutput: description: "" elasticcache_PerformSetAutoRenewOutput: description: "" elasticcache_PerformSetMaintainTimeOutput: description: "" elasticcache_PerformSetSecgroupOutput: description: "" elasticcache_PerformSyncOutput: description: "" elasticcache_PerformSyncstatusOutput: 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 elasticcacheaccount_CustomizeDeleteOutput: description: "" schema: properties: elasticcacheaccount: $ref: '#/definitions/ElasticcacheAccountDetails' type: object elasticcacheaccount_FetchCustomizeColumnsOutput: description: "" schema: properties: elasticcacheaccount: $ref: '#/definitions/ElasticcacheAccountDetails' type: object elasticcacheaccount_GetDetailsLoginInfoOutput: description: "" elasticcacheaccount_GetDetailsMetadataOutput: description: "" schema: properties: elasticcacheaccount: additionalProperties: type: string type: object x-go-name: Output type: object elasticcacheaccount_GetDetailsStatusOutput: description: "" schema: properties: elasticcacheaccount: $ref: '#/definitions/GetDetailsStatusOutput' type: object elasticcacheaccount_ListItemFilterOutput: description: "" schema: properties: elasticcacheaccounts: 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 elasticcacheaccount_PerformResetPasswordOutput: description: "" elasticcacheaccount_ValidateCreateDataOutput: description: "" schema: properties: elasticcacheaccount: $ref: '#/definitions/ElasticcacheAccountDetails' type: object elasticcacheaccount_ValidateUpdateDataOutput: description: "" schema: properties: elasticcacheaccount: $ref: '#/definitions/ElasticcacheAccountDetails' type: object elasticcacheacl_CustomizeDeleteOutput: description: "" schema: properties: elasticcacheacl: $ref: '#/definitions/ElasticcacheAclDetails' type: object elasticcacheacl_FetchCustomizeColumnsOutput: description: "" schema: properties: elasticcacheacl: $ref: '#/definitions/ElasticcacheAclDetails' type: object elasticcacheacl_GetDetailsMetadataOutput: description: "" schema: properties: elasticcacheacl: additionalProperties: type: string type: object x-go-name: Output type: object elasticcacheacl_GetDetailsStatusOutput: description: "" schema: properties: elasticcacheacl: $ref: '#/definitions/GetDetailsStatusOutput' type: object elasticcacheacl_ListItemFilterOutput: description: "" schema: properties: elasticcacheacls: 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 elasticcacheacl_ValidateCreateDataOutput: description: "" schema: properties: elasticcacheacl: $ref: '#/definitions/ElasticcacheAclDetails' type: object elasticcacheacl_ValidateUpdateDataOutput: description: "" schema: properties: elasticcacheacl: $ref: '#/definitions/ElasticcacheAclDetails' type: object elasticcachebackup_CustomizeDeleteOutput: description: "" schema: properties: elasticcachebackup: $ref: '#/definitions/ElasticcacheBackupDetails' type: object elasticcachebackup_FetchCustomizeColumnsOutput: description: "" schema: properties: elasticcachebackup: $ref: '#/definitions/ElasticcacheBackupDetails' type: object elasticcachebackup_GetDetailsMetadataOutput: description: "" schema: properties: elasticcachebackup: additionalProperties: type: string type: object x-go-name: Output type: object elasticcachebackup_GetDetailsStatusOutput: description: "" schema: properties: elasticcachebackup: $ref: '#/definitions/GetDetailsStatusOutput' type: object elasticcachebackup_ListItemFilterOutput: description: "" schema: properties: elasticcachebackups: 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 elasticcachebackup_PerformRestoreInstanceOutput: description: "" elasticcachebackup_ValidateCreateDataOutput: description: "" schema: properties: elasticcachebackup: $ref: '#/definitions/ElasticcacheBackupDetails' type: object elasticcachebackup_ValidateUpdateDataOutput: description: "" schema: properties: elasticcachebackup: $ref: '#/definitions/ElasticcacheBackupDetails' type: object elasticcacheparameter_CustomizeDeleteOutput: description: "" schema: properties: elasticcacheparameter: $ref: '#/definitions/ElasticcacheParameterDetails' type: object elasticcacheparameter_FetchCustomizeColumnsOutput: description: "" schema: properties: elasticcacheparameter: $ref: '#/definitions/ElasticcacheParameterDetails' type: object elasticcacheparameter_GetDetailsMetadataOutput: description: "" schema: properties: elasticcacheparameter: additionalProperties: type: string type: object x-go-name: Output type: object elasticcacheparameter_GetDetailsStatusOutput: description: "" schema: properties: elasticcacheparameter: $ref: '#/definitions/GetDetailsStatusOutput' type: object elasticcacheparameter_ListItemFilterOutput: description: "" schema: properties: elasticcacheparameters: 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 elasticcacheparameter_ValidateCreateDataOutput: description: "" schema: properties: elasticcacheparameter: $ref: '#/definitions/ElasticcacheParameterDetails' type: object elasticcacheparameter_ValidateUpdateDataOutput: description: "" schema: properties: elasticcacheparameter: $ref: '#/definitions/ElasticcacheParameterDetails' type: object elasticcachesku_CustomizeDeleteOutput: description: "" schema: properties: elasticcachesku: $ref: '#/definitions/ElasticcacheSkuDetails' type: object elasticcachesku_FetchCustomizeColumnsOutput: description: "" schema: properties: elasticcachesku: $ref: '#/definitions/ElasticcacheSkuDetails' type: object elasticcachesku_GetDetailsMetadataOutput: description: "" schema: properties: elasticcachesku: additionalProperties: type: string type: object x-go-name: Output type: object elasticcachesku_GetDetailsStatusOutput: description: "" schema: properties: elasticcachesku: $ref: '#/definitions/GetDetailsStatusOutput' type: object elasticcachesku_GetPropertyCapabilityOutput: description: "" elasticcachesku_GetPropertyInstanceSpecsOutput: description: "" elasticcachesku_GetPropertySyncTasksOutput: description: "" elasticcachesku_ListItemFilterOutput: description: "" schema: properties: elasticcacheskus: 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 elasticcachesku_PerformSyncSkusOutput: description: "" elasticcachesku_ValidateCreateDataOutput: description: "" schema: properties: elasticcachesku: $ref: '#/definitions/ElasticcacheSkuDetails' type: object elasticcachesku_ValidateUpdateDataOutput: description: "" schema: properties: elasticcachesku: $ref: '#/definitions/ElasticcacheSkuDetails' type: object externalproject_CustomizeDeleteOutput: description: "" schema: properties: externalproject: $ref: '#/definitions/ExternalProjectDetails' type: object externalproject_FetchCustomizeColumnsOutput: description: "" schema: properties: externalproject: $ref: '#/definitions/ExternalProjectDetails' type: object externalproject_GetDetailsMetadataOutput: description: "" schema: properties: externalproject: additionalProperties: type: string type: object x-go-name: Output type: object externalproject_GetDetailsStatusOutput: description: "" schema: properties: externalproject: $ref: '#/definitions/GetDetailsStatusOutput' type: object externalproject_ListItemFilterOutput: description: "" schema: properties: externalprojects: 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 externalproject_PerformChangeOwnerOutput: description: "" externalproject_PerformChangeProjectOutput: description: "" externalproject_ValidateCreateDataOutput: description: "" schema: properties: externalproject: $ref: '#/definitions/ExternalProjectDetails' type: object externalproject_ValidateUpdateDataOutput: description: "" schema: properties: externalproject: $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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" file_system_PerformPrivateOutput: description: "" file_system_PerformPublicOutput: description: "" file_system_PerformRemoteUpdateOutput: description: "" file_system_PerformSetQuotaOutput: description: "" file_system_PerformSyncstatusOutput: 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 globalvpc_CustomizeDeleteOutput: description: "" schema: properties: globalvpc: $ref: '#/definitions/GlobalVpcDetails' type: object globalvpc_FetchCustomizeColumnsOutput: description: "" schema: properties: globalvpc: $ref: '#/definitions/GlobalVpcDetails' type: object globalvpc_GetDetailsMetadataOutput: description: "" schema: properties: globalvpc: additionalProperties: type: string type: object x-go-name: Output type: object globalvpc_GetDetailsStatusOutput: description: "" schema: properties: globalvpc: $ref: '#/definitions/GetDetailsStatusOutput' type: object globalvpc_ListItemFilterOutput: description: "" schema: properties: globalvpcs: 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 globalvpc_PerformChangeOwnerOutput: description: "" globalvpc_PerformDisableOutput: description: "" globalvpc_PerformEnableOutput: description: "" globalvpc_PerformPrivateOutput: description: "" globalvpc_PerformPublicOutput: description: "" globalvpc_PerformSyncstatusOutput: description: "" globalvpc_ValidateCreateDataOutput: description: "" schema: properties: globalvpc: $ref: '#/definitions/GlobalVpcDetails' type: object globalvpc_ValidateUpdateDataOutput: description: "" schema: properties: globalvpc: $ref: '#/definitions/GlobalVpcDetails' type: object guest_network_traffic_log_CustomizeDeleteOutput: description: "" schema: properties: guest_network_traffic_log: $ref: '#/definitions/GuestNetworkTrafficLogDetails' type: object guest_network_traffic_log_FetchCustomizeColumnsOutput: description: "" schema: properties: guest_network_traffic_log: $ref: '#/definitions/GuestNetworkTrafficLogDetails' type: object guest_network_traffic_log_ListItemFilterOutput: description: "" schema: properties: guest_network_traffic_logs: items: $ref: '#/definitions/GuestNetworkTrafficLogDetails' 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_network_traffic_log_ValidateCreateDataOutput: description: "" schema: properties: guest_network_traffic_log: $ref: '#/definitions/GuestNetworkTrafficLogDetails' type: object guest_network_traffic_log_ValidateUpdateDataOutput: description: "" schema: properties: guest_network_traffic_log: $ref: '#/definitions/GuestNetworkTrafficLogDetails' type: object guest_screen_dump_CustomizeDeleteOutput: description: "" schema: properties: guest_screen_dump: $ref: '#/definitions/ResourceBaseDetails' type: object guest_screen_dump_FetchCustomizeColumnsOutput: description: "" schema: properties: guest_screen_dump: $ref: '#/definitions/ResourceBaseDetails' type: object guest_screen_dump_ListItemFilterOutput: description: "" schema: properties: guest_screen_dumps: 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 guest_screen_dump_ValidateCreateDataOutput: description: "" schema: properties: guest_screen_dump: $ref: '#/definitions/ResourceBaseDetails' type: object guest_screen_dump_ValidateUpdateDataOutput: description: "" schema: properties: guest_screen_dump: $ref: '#/definitions/ResourceBaseDetails' 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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" guest_template_PerformInspectOutput: description: "" guest_template_PerformPrivateOutput: description: "" guest_template_PerformPublicOutput: 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 guestnetworksecgroup_CustomizeDeleteOutput: description: "" schema: properties: guestnetworksecgroup: $ref: '#/definitions/GuestnetworksecgroupDetails' type: object guestnetworksecgroup_FetchCustomizeColumnsOutput: description: "" schema: properties: guestnetworksecgroup: $ref: '#/definitions/GuestnetworksecgroupDetails' type: object guestnetworksecgroup_ListItemFilterOutput: description: "" schema: properties: guestnetworksecgroups: items: $ref: '#/definitions/GuestnetworksecgroupDetails' 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 guestnetworksecgroup_ValidateCreateDataOutput: description: "" schema: properties: guestnetworksecgroup: $ref: '#/definitions/GuestnetworksecgroupDetails' type: object guestnetworksecgroup_ValidateUpdateDataOutput: description: "" schema: properties: guestnetworksecgroup: $ref: '#/definitions/GuestnetworksecgroupDetails' 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_GetDetailsHostFilesOutput: description: "" host_GetDetailsIpmiOutput: description: "" host_GetDetailsIsolatedDeviceNumaStatsOutput: 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_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_GetDetailsWorkerStatsOutput: description: "" host_GetPropertyBmStartRegisterScriptOutput: description: "" host_GetPropertyHostTypeCountOutput: description: "" host_GetPropertyK8sMasterNodeIpsOutput: description: "" host_GetPropertyNodeCountOutput: 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_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_PerformRemoveAllNetifsOutput: description: "" host_PerformRemoveNetifOutput: description: "" host_PerformRenewPrepaidRecycleOutput: description: "" host_PerformReportDmesgOutput: description: "" host_PerformReserveCpusOutput: description: "" host_PerformResetOutput: description: "" host_PerformRestartHostAgentOutput: description: "" host_PerformSetCommitBoundOutput: description: "" host_PerformSetHostFilesOutput: description: "" host_PerformSetReservedResourceForIsolatedDeviceOutput: description: "" host_PerformSetSchedtagOutput: description: "" host_PerformStartOutput: description: "" host_PerformStatusOutput: description: "" host_PerformStopOutput: description: "" host_PerformSyncConfigOutput: description: "" host_PerformSyncGuestNicTrafficsOutput: description: "" host_PerformSyncIsolatedDevicesOutput: description: "" host_PerformSyncstatusOutput: description: "" host_PerformUndoConvertOutput: description: "" host_PerformUndoPrepaidRecycleOutput: description: "" host_PerformUnmaintenanceOutput: description: "" host_PerformUnreserveCpusOutput: description: "" host_PerformUpdateStorageOutput: description: "" host_PerformValidateIpmiOutput: description: "" schema: properties: host: $ref: '#/definitions/ValidateIPMIResponse' type: object host_ValidateCreateDataOutput: description: "" schema: properties: host: $ref: '#/definitions/HostDetails' type: object host_ValidateUpdateDataOutput: description: "" schema: properties: host: $ref: '#/definitions/HostDetails' type: object host_dmesg_log_CustomizeDeleteOutput: description: "" schema: properties: host_dmesg_log: $ref: '#/definitions/OpsLogDetails' type: object host_dmesg_log_FetchCustomizeColumnsOutput: description: "" schema: properties: host_dmesg_log: $ref: '#/definitions/OpsLogDetails' type: object host_dmesg_log_ListItemFilterOutput: description: "" schema: properties: host_dmesg_logs: items: $ref: '#/definitions/OpsLogDetails' 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_dmesg_log_ValidateCreateDataOutput: description: "" schema: properties: host_dmesg_log: $ref: '#/definitions/OpsLogDetails' type: object host_dmesg_log_ValidateUpdateDataOutput: description: "" schema: properties: host_dmesg_log: $ref: '#/definitions/OpsLogDetails' type: object host_file_CustomizeDeleteOutput: description: "" schema: properties: host_file: $ref: '#/definitions/HostFileDetails' type: object host_file_FetchCustomizeColumnsOutput: description: "" schema: properties: host_file: $ref: '#/definitions/HostFileDetails' type: object host_file_GetDetailsMetadataOutput: description: "" schema: properties: host_file: additionalProperties: type: string type: object x-go-name: Output type: object host_file_ListItemFilterOutput: description: "" schema: properties: host_files: items: $ref: '#/definitions/HostFileDetails' 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_file_PerformChangeOwnerOutput: description: "" host_file_PerformPrivateOutput: description: "" host_file_PerformPublicOutput: description: "" host_file_ValidateCreateDataOutput: description: "" schema: properties: host_file: $ref: '#/definitions/HostFileDetails' type: object host_file_ValidateUpdateDataOutput: description: "" schema: properties: host_file: $ref: '#/definitions/HostFileDetails' 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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" instance_snapshot_PerformPurgeOutput: 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 instancebackup_CustomizeDeleteOutput: description: "" schema: properties: instancebackup: $ref: '#/definitions/InstanceBackupDetails' type: object instancebackup_FetchCustomizeColumnsOutput: description: "" schema: properties: instancebackup: $ref: '#/definitions/InstanceBackupDetails' type: object instancebackup_GetDetailsMetadataOutput: description: "" schema: properties: instancebackup: additionalProperties: type: string type: object x-go-name: Output type: object instancebackup_GetDetailsStatusOutput: description: "" schema: properties: instancebackup: $ref: '#/definitions/GetDetailsStatusOutput' type: object instancebackup_ListItemFilterOutput: description: "" schema: properties: instancebackups: 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 instancebackup_PerformChangeOwnerOutput: description: "" instancebackup_PerformPackOutput: description: "" instancebackup_PerformRecoveryOutput: description: "" instancebackup_PerformSyncstatusOutput: description: "" instancebackup_ValidateCreateDataOutput: description: "" schema: properties: instancebackup: $ref: '#/definitions/InstanceBackupDetails' type: object instancebackup_ValidateUpdateDataOutput: description: "" schema: properties: instancebackup: $ref: '#/definitions/InstanceBackupDetails' type: object instancegroup_CustomizeDeleteOutput: description: "" schema: properties: instancegroup: $ref: '#/definitions/InstanceGroupDetail' type: object instancegroup_FetchCustomizeColumnsOutput: description: "" schema: properties: instancegroup: $ref: '#/definitions/InstanceGroupDetail' type: object instancegroup_GetDetailsMetadataOutput: description: "" schema: properties: instancegroup: additionalProperties: type: string type: object x-go-name: Output type: object instancegroup_GetDetailsStatusOutput: description: "" schema: properties: instancegroup: $ref: '#/definitions/GetDetailsStatusOutput' type: object instancegroup_ListItemFilterOutput: description: "" schema: properties: instancegroups: 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 instancegroup_PerformAssociateEipOutput: description: "" instancegroup_PerformAttachnetworkOutput: description: "" schema: properties: instancegroup: $ref: '#/definitions/SGroup' type: object instancegroup_PerformBindGuestsOutput: description: "" instancegroup_PerformChangeOwnerOutput: description: "" instancegroup_PerformCreateEipOutput: description: "" instancegroup_PerformDetachnetworkOutput: description: "" schema: properties: instancegroup: $ref: '#/definitions/SGroup' type: object instancegroup_PerformDisableOutput: description: "" instancegroup_PerformDissociateEipOutput: description: "" instancegroup_PerformEnableOutput: description: "" instancegroup_PerformUnbindGuestsOutput: description: "" instancegroup_ValidateCreateDataOutput: description: "" schema: properties: instancegroup: $ref: '#/definitions/InstanceGroupDetail' type: object instancegroup_ValidateUpdateDataOutput: description: "" schema: properties: instancegroup: $ref: '#/definitions/InstanceGroupDetail' 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_GetDetailsMetadataOutput: 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_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_PerformDisableOutput: description: "" inter_vpc_network_PerformEnableOutput: description: "" inter_vpc_network_PerformPrivateOutput: description: "" inter_vpc_network_PerformPublicOutput: description: "" inter_vpc_network_PerformRemovevpcOutput: 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_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_GetDetailsStatusOutput: description: "" schema: properties: inter_vpc_network_route_set: $ref: '#/definitions/GetDetailsStatusOutput' type: object 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_PerformDisableOutput: description: "" inter_vpc_network_route_set_PerformEnableOutput: 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_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_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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" ipv6_gateway_PerformPrivateOutput: description: "" ipv6_gateway_PerformPublicOutput: 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_GetDetailsMetadataOutput: description: "" schema: properties: isolated_device: additionalProperties: type: string type: object x-go-name: Output type: object 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_PerformPrivateOutput: description: "" isolated_device_PerformPublicOutput: description: "" isolated_device_PerformPurgeOutput: 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_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_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_PerformSetHardwareInfoOutput: description: "" schema: properties: isolated_device_model: $ref: '#/definitions/IsolatedDeviceModelHardwareInfo' type: object 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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" kafka_PerformSyncstatusOutput: 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_GetDetailsMetadataOutput: description: "" schema: properties: keypair: additionalProperties: type: string type: object x-go-name: Output type: object keypair_GetDetailsPrivatekeyOutput: 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_PerformPrivateOutput: description: "" keypair_PerformPublicOutput: description: "" keypair_ValidateCreateDataOutput: description: "" schema: properties: keypair: $ref: '#/definitions/KeypairDetails' type: object keypair_ValidateUpdateDataOutput: description: "" schema: properties: keypair: $ref: '#/definitions/KeypairDetails' 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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" loadbalancer_PerformCreateEipOutput: description: "" loadbalancer_PerformDissociateEipOutput: description: "" loadbalancer_PerformPurgeOutput: description: "" loadbalancer_PerformRemoteUpdateOutput: description: "" loadbalancer_PerformStatusOutput: description: "" loadbalancer_PerformSyncstatusOutput: description: "" loadbalancer_ValidateCreateDataOutput: description: "" schema: properties: loadbalancer: $ref: '#/definitions/LoadbalancerDetails' type: object loadbalancer_ValidateUpdateDataOutput: description: "" schema: properties: loadbalancer: $ref: '#/definitions/LoadbalancerDetails' type: object loadbalancer_health_check_CustomizeDeleteOutput: description: "" schema: properties: loadbalancer_health_check: $ref: '#/definitions/LoadbalancerHealthCheckDetails' type: object loadbalancer_health_check_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalancer_health_check: $ref: '#/definitions/LoadbalancerHealthCheckDetails' type: object loadbalancer_health_check_GetDetailsMetadataOutput: description: "" schema: properties: loadbalancer_health_check: additionalProperties: type: string type: object x-go-name: Output type: object loadbalancer_health_check_GetDetailsStatusOutput: description: "" schema: properties: loadbalancer_health_check: $ref: '#/definitions/GetDetailsStatusOutput' type: object loadbalancer_health_check_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalancerhealthchecks: items: $ref: '#/definitions/LoadbalancerHealthCheckDetails' 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_health_check_PerformChangeOwnerOutput: description: "" loadbalancer_health_check_PerformSyncstatusOutput: description: "" loadbalancer_health_check_ValidateCreateDataOutput: description: "" schema: properties: loadbalancer_health_check: $ref: '#/definitions/LoadbalancerHealthCheckDetails' type: object loadbalancer_health_check_ValidateUpdateDataOutput: description: "" schema: properties: loadbalancer_health_check: $ref: '#/definitions/LoadbalancerHealthCheckDetails' 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_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_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 loadbalanceracl_CustomizeDeleteOutput: description: "" schema: properties: loadbalanceracl: $ref: '#/definitions/LoadbalancerAclDetails' type: object loadbalanceracl_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalanceracl: $ref: '#/definitions/LoadbalancerAclDetails' type: object loadbalanceracl_GetDetailsMetadataOutput: description: "" schema: properties: loadbalanceracl: additionalProperties: type: string type: object x-go-name: Output type: object loadbalanceracl_GetDetailsStatusOutput: description: "" schema: properties: loadbalanceracl: $ref: '#/definitions/GetDetailsStatusOutput' type: object loadbalanceracl_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalanceracls: 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 loadbalanceracl_PerformChangeOwnerOutput: description: "" loadbalanceracl_PerformPatchOutput: description: "" loadbalanceracl_PerformPrivateOutput: description: "" loadbalanceracl_PerformPublicOutput: description: "" loadbalanceracl_PerformPurgeOutput: description: "" loadbalanceracl_PerformSyncstatusOutput: description: "" loadbalanceracl_ValidateCreateDataOutput: description: "" schema: properties: loadbalanceracl: $ref: '#/definitions/LoadbalancerAclDetails' type: object loadbalanceracl_ValidateUpdateDataOutput: description: "" schema: properties: loadbalanceracl: $ref: '#/definitions/LoadbalancerAclDetails' type: object loadbalanceragent_CustomizeDeleteOutput: description: "" schema: properties: loadbalanceragent: $ref: '#/definitions/LoadbalancerAgentDetails' type: object loadbalanceragent_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalanceragent: $ref: '#/definitions/LoadbalancerAgentDetails' type: object loadbalanceragent_GetDetailsMetadataOutput: description: "" schema: properties: loadbalanceragent: additionalProperties: type: string type: object x-go-name: Output type: object loadbalanceragent_GetPropertyDefaultParamsOutput: description: "" loadbalanceragent_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalanceragents: 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 loadbalanceragent_PerformDeployOutput: description: "" schema: properties: loadbalanceragent: $ref: '#/definitions/LoadbalancerAgentDeployInput' type: object loadbalanceragent_PerformHbOutput: description: "" loadbalanceragent_PerformJoinClusterOutput: description: "" loadbalanceragent_PerformLeaveClusterOutput: description: "" loadbalanceragent_PerformParamsPatchOutput: description: "" loadbalanceragent_PerformUndeployOutput: description: "" loadbalanceragent_ValidateCreateDataOutput: description: "" schema: properties: loadbalanceragent: $ref: '#/definitions/LoadbalancerAgentDetails' type: object loadbalanceragent_ValidateUpdateDataOutput: description: "" schema: properties: loadbalanceragent: $ref: '#/definitions/LoadbalancerAgentDetails' type: object loadbalancerbackend_CustomizeDeleteOutput: description: "" schema: properties: loadbalancerbackend: $ref: '#/definitions/LoadbalancerBackendDetails' type: object loadbalancerbackend_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalancerbackend: $ref: '#/definitions/LoadbalancerBackendDetails' type: object loadbalancerbackend_GetDetailsMetadataOutput: description: "" schema: properties: loadbalancerbackend: additionalProperties: type: string type: object x-go-name: Output type: object loadbalancerbackend_GetDetailsStatusOutput: description: "" schema: properties: loadbalancerbackend: $ref: '#/definitions/GetDetailsStatusOutput' type: object loadbalancerbackend_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalancerbackends: 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 loadbalancerbackend_PerformPurgeOutput: description: "" loadbalancerbackend_ValidateCreateDataOutput: description: "" schema: properties: loadbalancerbackend: $ref: '#/definitions/LoadbalancerBackendDetails' type: object loadbalancerbackend_ValidateUpdateDataOutput: description: "" schema: properties: loadbalancerbackend: $ref: '#/definitions/LoadbalancerBackendDetails' type: object loadbalancerbackendgroup_CustomizeDeleteOutput: description: "" schema: properties: loadbalancerbackendgroup: $ref: '#/definitions/LoadbalancerBackendGroupDetails' type: object loadbalancerbackendgroup_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalancerbackendgroup: $ref: '#/definitions/LoadbalancerBackendGroupDetails' type: object loadbalancerbackendgroup_GetDetailsMetadataOutput: description: "" schema: properties: loadbalancerbackendgroup: additionalProperties: type: string type: object x-go-name: Output type: object loadbalancerbackendgroup_GetDetailsStatusOutput: description: "" schema: properties: loadbalancerbackendgroup: $ref: '#/definitions/GetDetailsStatusOutput' type: object loadbalancerbackendgroup_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalancerbackendgroups: 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 loadbalancerbackendgroup_PerformPurgeOutput: description: "" loadbalancerbackendgroup_ValidateCreateDataOutput: description: "" schema: properties: loadbalancerbackendgroup: $ref: '#/definitions/LoadbalancerBackendGroupDetails' type: object loadbalancerbackendgroup_ValidateUpdateDataOutput: description: "" schema: properties: loadbalancerbackendgroup: $ref: '#/definitions/LoadbalancerBackendGroupDetails' type: object loadbalancercertificate_CustomizeDeleteOutput: description: "" schema: properties: loadbalancercertificate: $ref: '#/definitions/LoadbalancerCertificateDetails' type: object loadbalancercertificate_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalancercertificate: $ref: '#/definitions/LoadbalancerCertificateDetails' type: object loadbalancercertificate_GetDetailsMetadataOutput: description: "" schema: properties: loadbalancercertificate: additionalProperties: type: string type: object x-go-name: Output type: object loadbalancercertificate_GetDetailsStatusOutput: description: "" schema: properties: loadbalancercertificate: $ref: '#/definitions/GetDetailsStatusOutput' type: object loadbalancercertificate_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalancercertificates: 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 loadbalancercertificate_PerformChangeOwnerOutput: description: "" loadbalancercertificate_PerformPrivateOutput: description: "" loadbalancercertificate_PerformPublicOutput: description: "" loadbalancercertificate_PerformSyncstatusOutput: description: "" loadbalancercertificate_ValidateCreateDataOutput: description: "" schema: properties: loadbalancercertificate: $ref: '#/definitions/LoadbalancerCertificateDetails' type: object loadbalancercertificate_ValidateUpdateDataOutput: description: "" schema: properties: loadbalancercertificate: $ref: '#/definitions/LoadbalancerCertificateDetails' type: object loadbalancercluster_CustomizeDeleteOutput: description: "" schema: properties: loadbalancercluster: $ref: '#/definitions/LoadbalancerClusterDetails' type: object loadbalancercluster_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalancercluster: $ref: '#/definitions/LoadbalancerClusterDetails' type: object loadbalancercluster_GetDetailsMetadataOutput: description: "" schema: properties: loadbalancercluster: additionalProperties: type: string type: object x-go-name: Output type: object loadbalancercluster_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalancerclusters: 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 loadbalancercluster_PerformParamsPatchOutput: description: "" loadbalancercluster_ValidateCreateDataOutput: description: "" schema: properties: loadbalancercluster: $ref: '#/definitions/LoadbalancerClusterDetails' type: object loadbalancercluster_ValidateUpdateDataOutput: description: "" schema: properties: loadbalancercluster: $ref: '#/definitions/LoadbalancerClusterDetails' type: object loadbalancerlistener_CustomizeDeleteOutput: description: "" schema: properties: loadbalancerlistener: $ref: '#/definitions/LoadbalancerListenerDetails' type: object loadbalancerlistener_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalancerlistener: $ref: '#/definitions/LoadbalancerListenerDetails' type: object loadbalancerlistener_GetDetailsBackendStatusOutput: description: "" loadbalancerlistener_GetDetailsMetadataOutput: description: "" schema: properties: loadbalancerlistener: additionalProperties: type: string type: object x-go-name: Output type: object loadbalancerlistener_GetDetailsStatusOutput: description: "" schema: properties: loadbalancerlistener: $ref: '#/definitions/GetDetailsStatusOutput' type: object loadbalancerlistener_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalancerlisteners: 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 loadbalancerlistener_PerformPurgeOutput: description: "" loadbalancerlistener_PerformStatusOutput: description: "" loadbalancerlistener_PerformSyncOutput: description: "" loadbalancerlistener_PerformSyncstatusOutput: description: "" loadbalancerlistener_ValidateCreateDataOutput: description: "" schema: properties: loadbalancerlistener: $ref: '#/definitions/LoadbalancerListenerDetails' type: object loadbalancerlistener_ValidateUpdateDataOutput: description: "" schema: properties: loadbalancerlistener: $ref: '#/definitions/LoadbalancerListenerDetails' type: object loadbalancerlistenerrule_CustomizeDeleteOutput: description: "" schema: properties: loadbalancerlistenerrule: $ref: '#/definitions/LoadbalancerListenerRuleDetails' type: object loadbalancerlistenerrule_FetchCustomizeColumnsOutput: description: "" schema: properties: loadbalancerlistenerrule: $ref: '#/definitions/LoadbalancerListenerRuleDetails' type: object loadbalancerlistenerrule_GetDetailsBackendStatusOutput: description: "" loadbalancerlistenerrule_GetDetailsMetadataOutput: description: "" schema: properties: loadbalancerlistenerrule: additionalProperties: type: string type: object x-go-name: Output type: object loadbalancerlistenerrule_GetDetailsStatusOutput: description: "" schema: properties: loadbalancerlistenerrule: $ref: '#/definitions/GetDetailsStatusOutput' type: object loadbalancerlistenerrule_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit loadbalancerlistenerrules: 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 loadbalancerlistenerrule_PerformPurgeOutput: description: "" loadbalancerlistenerrule_ValidateCreateDataOutput: description: "" schema: properties: loadbalancerlistenerrule: $ref: '#/definitions/LoadbalancerListenerRuleDetails' type: object loadbalancerlistenerrule_ValidateUpdateDataOutput: description: "" schema: properties: loadbalancerlistenerrule: $ref: '#/definitions/LoadbalancerListenerRuleDetails' 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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: 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_GetDetailsMetadataOutput: 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_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_PerformChangeConfigOutput: description: "" modelarts_pool_PerformChangeOwnerOutput: description: "" modelarts_pool_PerformSyncstatusOutput: 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_GetDetailsMetadataOutput: 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_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_PerformDisableOutput: description: "" modelarts_pool_sku_PerformEnableOutput: 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 mongodb_CustomizeDeleteOutput: description: "" schema: properties: mongodb: $ref: '#/definitions/MongoDBDetails' type: object mongodb_FetchCustomizeColumnsOutput: description: "" schema: properties: mongodb: $ref: '#/definitions/MongoDBDetails' type: object mongodb_GetDetailsBackupsOutput: description: "" schema: properties: mongodb: $ref: '#/definitions/SMongoDBBackups' type: object mongodb_GetDetailsMetadataOutput: description: "" schema: properties: mongodb: additionalProperties: type: string type: object x-go-name: Output type: object mongodb_GetDetailsStatusOutput: description: "" schema: properties: mongodb: $ref: '#/definitions/GetDetailsStatusOutput' type: object mongodb_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit mongodbs: 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 mongodb_PerformCancelExpireOutput: description: "" mongodb_PerformChangeOwnerOutput: description: "" mongodb_PerformPostpaidExpireOutput: description: "" mongodb_PerformRemoteUpdateOutput: description: "" mongodb_PerformSyncstatusOutput: description: "" mongodb_ValidateCreateDataOutput: description: "" schema: properties: mongodb: $ref: '#/definitions/MongoDBDetails' type: object mongodb_ValidateUpdateDataOutput: description: "" schema: properties: mongodb: $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_GetDetailsMetadataOutput: 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_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_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_GetDetailsMetadataOutput: 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_GetPropertySyncTasksOutput: 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_PerformDisableOutput: description: "" nas_sku_PerformEnableOutput: 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_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_GetDetailsMetadataOutput: 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_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_PerformPrivateOutput: description: "" nat_entry_PerformPublicOutput: 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_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_GetDetailsMetadataOutput: 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_GetPropertySyncTasksOutput: 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_PerformDisableOutput: description: "" nat_sku_PerformEnableOutput: 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 natdentry_CustomizeDeleteOutput: description: "" schema: properties: natdentry: $ref: '#/definitions/NatDEntryDetails' type: object natdentry_FetchCustomizeColumnsOutput: description: "" schema: properties: natdentry: $ref: '#/definitions/NatDEntryDetails' type: object natdentry_GetDetailsMetadataOutput: description: "" schema: properties: natdentry: additionalProperties: type: string type: object x-go-name: Output type: object natdentry_GetDetailsStatusOutput: description: "" schema: properties: natdentry: $ref: '#/definitions/GetDetailsStatusOutput' type: object natdentry_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit natdentries: 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 natdentry_PerformChangeOwnerOutput: description: "" natdentry_PerformPrivateOutput: description: "" natdentry_PerformPublicOutput: description: "" natdentry_ValidateCreateDataOutput: description: "" schema: properties: natdentry: $ref: '#/definitions/NatDEntryDetails' type: object natdentry_ValidateUpdateDataOutput: description: "" schema: properties: natdentry: $ref: '#/definitions/NatDEntryDetails' type: object natgateway_CustomizeDeleteOutput: description: "" schema: properties: natgateway: $ref: '#/definitions/NatgatewayDetails' type: object natgateway_FetchCustomizeColumnsOutput: description: "" schema: properties: natgateway: $ref: '#/definitions/NatgatewayDetails' type: object natgateway_GetDetailsMetadataOutput: description: "" schema: properties: natgateway: additionalProperties: type: string type: object x-go-name: Output type: object natgateway_GetDetailsStatusOutput: description: "" schema: properties: natgateway: $ref: '#/definitions/GetDetailsStatusOutput' type: object natgateway_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit natgateways: 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 natgateway_PerformCancelExpireOutput: description: "" natgateway_PerformChangeOwnerOutput: description: "" natgateway_PerformDnatResourcesOutput: description: "" natgateway_PerformPostpaidExpireOutput: description: "" natgateway_PerformPrivateOutput: description: "" natgateway_PerformPublicOutput: description: "" natgateway_PerformRemoteUpdateOutput: description: "" natgateway_PerformRenewOutput: description: "" natgateway_PerformSetAutoRenewOutput: description: "" natgateway_PerformSnatResourcesOutput: description: "" natgateway_PerformSyncstatusOutput: description: "" natgateway_ValidateCreateDataOutput: description: "" schema: properties: natgateway: $ref: '#/definitions/NatgatewayDetails' type: object natgateway_ValidateUpdateDataOutput: description: "" schema: properties: natgateway: $ref: '#/definitions/NatgatewayDetails' type: object natsentry_CustomizeDeleteOutput: description: "" schema: properties: natsentry: $ref: '#/definitions/NatSEntryDetails' type: object natsentry_FetchCustomizeColumnsOutput: description: "" schema: properties: natsentry: $ref: '#/definitions/NatSEntryDetails' type: object natsentry_GetDetailsMetadataOutput: description: "" schema: properties: natsentry: additionalProperties: type: string type: object x-go-name: Output type: object natsentry_GetDetailsStatusOutput: description: "" schema: properties: natsentry: $ref: '#/definitions/GetDetailsStatusOutput' type: object natsentry_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit natsenties: 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 natsentry_PerformChangeOwnerOutput: description: "" natsentry_PerformPrivateOutput: description: "" natsentry_PerformPublicOutput: description: "" natsentry_ValidateCreateDataOutput: description: "" schema: properties: natsentry: $ref: '#/definitions/NatSEntryDetails' type: object natsentry_ValidateUpdateDataOutput: description: "" schema: properties: natsentry: $ref: '#/definitions/NatSEntryDetails' 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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" network_PerformMergeOutput: description: "" network_PerformPrivateOutput: description: "" network_PerformPublicOutput: description: "" network_PerformPurgeOutput: description: "" network_PerformReleaseReservedIpOutput: description: "" network_PerformReserveIpOutput: description: "" network_PerformSetBgpTypeOutput: description: "" network_PerformSetSchedtagOutput: description: "" network_PerformSplitOutput: description: "" network_PerformStatusOutput: description: "" network_PerformSwitchWireOutput: description: "" network_PerformSyncAdditionalWiresOutput: description: "" network_PerformSyncOutput: description: "" network_PerformSyncstatusOutput: description: "" network_PerformTryCreateNetworkOutput: 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_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_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_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_GetDetailsMetadataOutput: description: "" schema: properties: network_ip_mac: additionalProperties: type: string type: object x-go-name: Output type: object 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_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 networkaddress_CustomizeDeleteOutput: description: "" schema: properties: networkaddress: $ref: '#/definitions/NetworkAddressDetails' type: object networkaddress_FetchCustomizeColumnsOutput: description: "" schema: properties: networkaddress: $ref: '#/definitions/NetworkAddressDetails' type: object networkaddress_GetDetailsMetadataOutput: description: "" schema: properties: networkaddress: additionalProperties: type: string type: object x-go-name: Output type: object networkaddress_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit networkaddresses: 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 networkaddress_ValidateCreateDataOutput: description: "" schema: properties: networkaddress: $ref: '#/definitions/NetworkAddressDetails' type: object networkaddress_ValidateUpdateDataOutput: description: "" schema: properties: networkaddress: $ref: '#/definitions/NetworkAddressDetails' type: object networkinterface_CustomizeDeleteOutput: description: "" schema: properties: networkinterface: $ref: '#/definitions/NetworkInterfaceDetails' type: object networkinterface_FetchCustomizeColumnsOutput: description: "" schema: properties: networkinterface: $ref: '#/definitions/NetworkInterfaceDetails' type: object networkinterface_GetDetailsMetadataOutput: description: "" schema: properties: networkinterface: additionalProperties: type: string type: object x-go-name: Output type: object networkinterface_GetDetailsStatusOutput: description: "" schema: properties: networkinterface: $ref: '#/definitions/GetDetailsStatusOutput' type: object networkinterface_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit networkinterfaces: 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 networkinterface_PerformChangeOwnerOutput: description: "" networkinterface_PerformPrivateOutput: description: "" networkinterface_PerformPublicOutput: description: "" networkinterface_ValidateCreateDataOutput: description: "" schema: properties: networkinterface: $ref: '#/definitions/NetworkInterfaceDetails' type: object networkinterface_ValidateUpdateDataOutput: description: "" schema: properties: networkinterface: $ref: '#/definitions/NetworkInterfaceDetails' 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_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_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_GetDetailsMetadataOutput: description: "" schema: properties: policy_assignment: additionalProperties: type: string type: object x-go-name: Output type: object 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_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_GetDetailsMetadataOutput: 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_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_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_GetDetailsMetadataOutput: 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_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_PerformDisableOutput: description: "" project_mapping_PerformEnableOutput: description: "" project_mapping_PerformPrivateOutput: description: "" project_mapping_PerformPublicOutput: 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_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_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_GetDetailsMetadataOutput: 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_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_PerformDelRoutesOutput: description: "" route_table_PerformPrivateOutput: description: "" route_table_PerformPublicOutput: description: "" route_table_PerformPurgeOutput: 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_GetDetailsMetadataOutput: 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_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_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_GetDetailsMetadataOutput: 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_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_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_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_GetDetailsMetadataOutput: description: "" schema: properties: scaling_alarm: additionalProperties: type: string type: object x-go-name: Output type: object 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_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_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_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_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_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_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_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_GetDetailsMetadataOutput: description: "" schema: properties: scaling_timer: additionalProperties: type: string type: object x-go-name: Output type: object 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_ValidateCreateDataOutput: description: "" schema: properties: scaling_timer: $ref: '#/definitions/StandaloneResourceDetails' type: object scaling_timer_ValidateUpdateDataOutput: description: "" schema: properties: scaling_timer: $ref: '#/definitions/StandaloneResourceDetails' type: object scalingactivity_CustomizeDeleteOutput: description: "" schema: properties: scalingactivity: $ref: '#/definitions/ScalingActivityDetails' type: object scalingactivity_FetchCustomizeColumnsOutput: description: "" schema: properties: scalingactivity: $ref: '#/definitions/ScalingActivityDetails' type: object scalingactivity_GetDetailsMetadataOutput: description: "" schema: properties: scalingactivity: additionalProperties: type: string type: object x-go-name: Output type: object scalingactivity_GetDetailsStatusOutput: description: "" schema: properties: scalingactivity: $ref: '#/definitions/GetDetailsStatusOutput' type: object scalingactivity_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset scalingactivities: items: $ref: '#/definitions/ScalingActivityDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object scalingactivity_ValidateCreateDataOutput: description: "" schema: properties: scalingactivity: $ref: '#/definitions/ScalingActivityDetails' type: object scalingactivity_ValidateUpdateDataOutput: description: "" schema: properties: scalingactivity: $ref: '#/definitions/ScalingActivityDetails' type: object scalinggroup_CustomizeDeleteOutput: description: "" schema: properties: scalinggroup: $ref: '#/definitions/ScalingGroupDetails' type: object scalinggroup_FetchCustomizeColumnsOutput: description: "" schema: properties: scalinggroup: $ref: '#/definitions/ScalingGroupDetails' type: object scalinggroup_GetDetailsMetadataOutput: description: "" schema: properties: scalinggroup: additionalProperties: type: string type: object x-go-name: Output type: object scalinggroup_GetDetailsStatusOutput: description: "" schema: properties: scalinggroup: $ref: '#/definitions/GetDetailsStatusOutput' type: object scalinggroup_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset scalinggroups: items: $ref: '#/definitions/ScalingGroupDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object scalinggroup_PerformChangeOwnerOutput: description: "" scalinggroup_PerformDisableOutput: description: "" scalinggroup_PerformEnableOutput: description: "" scalinggroup_ValidateCreateDataOutput: description: "" schema: properties: scalinggroup: $ref: '#/definitions/ScalingGroupDetails' type: object scalinggroup_ValidateUpdateDataOutput: description: "" schema: properties: scalinggroup: $ref: '#/definitions/ScalingGroupDetails' type: object scalingpolicy_CustomizeDeleteOutput: description: "" schema: properties: scalingpolicy: $ref: '#/definitions/ScalingPolicyDetails' type: object scalingpolicy_FetchCustomizeColumnsOutput: description: "" schema: properties: scalingpolicy: $ref: '#/definitions/ScalingPolicyDetails' type: object scalingpolicy_GetDetailsMetadataOutput: description: "" schema: properties: scalingpolicy: additionalProperties: type: string type: object x-go-name: Output type: object scalingpolicy_GetDetailsStatusOutput: description: "" schema: properties: scalingpolicy: $ref: '#/definitions/GetDetailsStatusOutput' type: object scalingpolicy_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset scalingpolicies: items: $ref: '#/definitions/ScalingPolicyDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object scalingpolicy_PerformChangeOwnerOutput: description: "" scalingpolicy_PerformDisableOutput: description: "" scalingpolicy_PerformEnableOutput: description: "" scalingpolicy_PerformTriggerOutput: description: "" scalingpolicy_ValidateCreateDataOutput: description: "" schema: properties: scalingpolicy: $ref: '#/definitions/ScalingPolicyDetails' type: object scalingpolicy_ValidateUpdateDataOutput: description: "" schema: properties: scalingpolicy: $ref: '#/definitions/ScalingPolicyDetails' 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_GetDetailsMetadataOutput: description: "" schema: properties: schedpolicy: additionalProperties: type: string type: object x-go-name: Output type: object 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_PerformEvaluateOutput: 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_GetDetailsMetadataOutput: description: "" schema: properties: schedtag: additionalProperties: type: string type: object x-go-name: Output type: object 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_PerformSetResourceOutput: description: "" schedtag_PerformSetScopeOutput: description: "" schedtag_ValidateCreateDataOutput: description: "" schema: properties: schedtag: $ref: '#/definitions/SchedtagDetails' type: object schedtag_ValidateUpdateDataOutput: description: "" schema: properties: schedtag: $ref: '#/definitions/SchedtagDetails' type: object secgroup_CustomizeDeleteOutput: description: "" schema: properties: secgroup: $ref: '#/definitions/SecgroupDetails' type: object secgroup_FetchCustomizeColumnsOutput: description: "" schema: properties: secgroup: $ref: '#/definitions/SecgroupDetails' type: object secgroup_GetDetailsMetadataOutput: description: "" schema: properties: secgroup: additionalProperties: type: string type: object x-go-name: Output type: object secgroup_GetDetailsStatusOutput: description: "" schema: properties: secgroup: $ref: '#/definitions/GetDetailsStatusOutput' type: object secgroup_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset secgroups: items: $ref: '#/definitions/SecgroupDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object secgroup_PerformAddRuleOutput: description: "" secgroup_PerformChangeOwnerOutput: description: "" secgroup_PerformCleanOutput: description: "" secgroup_PerformCloneOutput: description: "" schema: properties: secgroup: $ref: '#/definitions/SecurityGroupCloneInput' type: object secgroup_PerformImportRulesOutput: description: "" secgroup_PerformPrivateOutput: description: "" secgroup_PerformPublicOutput: description: "" secgroup_PerformSyncstatusOutput: description: "" secgroup_ValidateCreateDataOutput: description: "" schema: properties: secgroup: $ref: '#/definitions/SecgroupDetails' type: object secgroup_ValidateUpdateDataOutput: description: "" schema: properties: secgroup: $ref: '#/definitions/SecgroupDetails' type: object secgrouprule_CustomizeDeleteOutput: description: "" schema: properties: secgrouprule: $ref: '#/definitions/SecgroupRuleDetails' type: object secgrouprule_FetchCustomizeColumnsOutput: description: "" schema: properties: secgrouprule: $ref: '#/definitions/SecgroupRuleDetails' type: object secgrouprule_GetDetailsStatusOutput: description: "" schema: properties: secgrouprule: $ref: '#/definitions/GetDetailsStatusOutput' type: object secgrouprule_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset secgrouprules: items: $ref: '#/definitions/SecgroupRuleDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object secgrouprule_ValidateCreateDataOutput: description: "" schema: properties: secgrouprule: $ref: '#/definitions/SecgroupRuleDetails' type: object secgrouprule_ValidateUpdateDataOutput: description: "" schema: properties: secgrouprule: $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_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_GetDetailsKickstartOutput: 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_GetDetailsNumaInfoOutput: description: "" schema: properties: server: $ref: '#/definitions/ServerGetNumaInfoResp' type: object server_GetDetailsQemuInfoOutput: description: "" schema: properties: server: $ref: '#/definitions/ServerQemuInfo' type: object server_GetDetailsRemoteNicsOutput: description: "" server_GetDetailsScreenDumpShowOutput: description: "" schema: properties: server: $ref: '#/definitions/GetDetailsGuestScreenDumpOutput' type: object 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_GetPropertyStatisticsOutput: description: "" schema: properties: server: $ref: '#/definitions/StatusStatistic' type: object 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_PerformAddNetworkSecgroupOutput: description: "" 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_PerformBatchConvertPrecheckOutput: description: "" server_PerformBatchMigrateOutput: description: "" server_PerformBatchSetUserMetadataOutput: description: "" server_PerformBatchUserMetadataOutput: description: "" server_PerformBindGroupsOutput: description: "" server_PerformBindSnapshotpolicyOutput: description: "" server_PerformBlockMirrorReadyOutput: description: "" server_PerformBlockStreamFailedOutput: description: "" server_PerformCalculateRecordChecksumOutput: description: "" server_PerformCancelDeleteOutput: description: "" server_PerformCancelExpireOutput: description: "" server_PerformCancelLiveMigrateOutput: description: "" server_PerformChangeBandwidthOutput: description: "" server_PerformChangeBillingTypeOutput: 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_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_PerformDeleteKickstartOutput: description: "" server_PerformDeployOutput: description: "" server_PerformDetachIsolatedDeviceOutput: description: "" server_PerformDetachScalingGroupOutput: description: "" server_PerformDetachdiskOutput: description: "" server_PerformDetachnetworkOutput: description: "" server_PerformDirtyServerStartOutput: description: "" server_PerformDirtyServerVerifyOutput: description: "" server_PerformDisableAutoMergeSnapshotsOutput: 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_PerformKickstartCompleteOutput: 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_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_PerformRestoreVirtualIsolatedDevicesOutput: description: "" server_PerformResumeOutput: description: "" server_PerformRevokeAdminSecgroupOutput: description: "" server_PerformRevokeNetworkSecgroupOutput: description: "" server_PerformRevokeSecgroupOutput: description: "" server_PerformSaveGuestImageOutput: description: "" server_PerformSaveImageOutput: description: "" schema: properties: server: $ref: '#/definitions/ServerSaveImageInput' type: object server_PerformSaveTemplateOutput: description: "" server_PerformScreenDumpOutput: description: "" server_PerformSendkeysOutput: description: "" server_PerformSetAutoRenewOutput: description: "" server_PerformSetBootIndexOutput: description: "" server_PerformSetExtraOptionOutput: description: "" server_PerformSetIsolatedDeviceOutput: description: "" server_PerformSetKickstartOutput: description: "" server_PerformSetNetworkNumQueuesOutput: description: "" server_PerformSetNetworkSecgroupOutput: description: "" server_PerformSetNicTrafficLimitOutput: description: "" server_PerformSetOsInfoOutput: description: "" server_PerformSetPasswordOutput: description: "" server_PerformSetQemuParamsOutput: description: "" server_PerformSetRootDiskMatcherOutput: description: "" server_PerformSetSecgroupOutput: description: "" server_PerformSetSnapshotpolicyOutput: description: "" server_PerformSetSshportOutput: description: "" server_PerformSetTpmOutput: 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_PerformUpdateKickstartStatusOutput: description: "" server_PerformUpdateSubIpsOutput: description: "" server_PerformUploadStatusOutput: description: "" schema: properties: server: $ref: '#/definitions/GuestUploadStatusResponse' type: object 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 serversku_CustomizeDeleteOutput: description: "" schema: properties: serversku: $ref: '#/definitions/ServerSkuDetails' type: object serversku_FetchCustomizeColumnsOutput: description: "" schema: properties: serversku: $ref: '#/definitions/ServerSkuDetails' type: object serversku_GetDetailsMetadataOutput: description: "" schema: properties: serversku: additionalProperties: type: string type: object x-go-name: Output type: object serversku_GetDetailsStatusOutput: description: "" schema: properties: serversku: $ref: '#/definitions/GetDetailsStatusOutput' type: object serversku_GetPropertyInstanceSpecsOutput: description: "" serversku_GetPropertySyncTasksOutput: description: "" serversku_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset serverskus: items: $ref: '#/definitions/ServerSkuDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object serversku_PerformDisableOutput: description: "" serversku_PerformEnableOutput: description: "" serversku_PerformSyncSkusOutput: description: "" serversku_ValidateCreateDataOutput: description: "" schema: properties: serversku: $ref: '#/definitions/ServerSkuDetails' type: object serversku_ValidateUpdateDataOutput: description: "" schema: properties: serversku: $ref: '#/definitions/ServerSkuDetails' type: object servicecatalog_CustomizeDeleteOutput: description: "" schema: properties: servicecatalog: $ref: '#/definitions/ServiceCatalogDetails' type: object servicecatalog_FetchCustomizeColumnsOutput: description: "" schema: properties: servicecatalog: $ref: '#/definitions/ServiceCatalogDetails' type: object servicecatalog_GetDetailsMetadataOutput: description: "" schema: properties: servicecatalog: additionalProperties: type: string type: object x-go-name: Output type: object servicecatalog_GetDetailsStatusOutput: description: "" schema: properties: servicecatalog: $ref: '#/definitions/GetDetailsStatusOutput' type: object servicecatalog_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset servicecatalogs: items: $ref: '#/definitions/ServiceCatalogDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object servicecatalog_PerformChangeOwnerOutput: description: "" servicecatalog_PerformDeployOutput: description: "" servicecatalog_PerformPrivateOutput: description: "" servicecatalog_PerformPublicOutput: description: "" servicecatalog_ValidateCreateDataOutput: description: "" schema: properties: servicecatalog: $ref: '#/definitions/ServiceCatalogDetails' type: object servicecatalog_ValidateUpdateDataOutput: description: "" schema: properties: servicecatalog: $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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" snapshot_PerformSyncstatusOutput: 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_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_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_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 snapshot_policy_resource_CustomizeDeleteOutput: description: "" schema: properties: snapshot_policy_resource: $ref: '#/definitions/ResourceBaseDetails' type: object snapshot_policy_resource_FetchCustomizeColumnsOutput: description: "" schema: properties: snapshot_policy_resource: $ref: '#/definitions/ResourceBaseDetails' type: object snapshot_policy_resource_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset snapshot_policy_resources: items: $ref: '#/definitions/ResourceBaseDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object snapshot_policy_resource_ValidateCreateDataOutput: description: "" schema: properties: snapshot_policy_resource: $ref: '#/definitions/ResourceBaseDetails' type: object snapshot_policy_resource_ValidateUpdateDataOutput: description: "" schema: properties: snapshot_policy_resource: $ref: '#/definitions/ResourceBaseDetails' type: object snapshotpolicy_CustomizeDeleteOutput: description: "" schema: properties: snapshotpolicy: $ref: '#/definitions/SnapshotPolicyDetails' type: object snapshotpolicy_FetchCustomizeColumnsOutput: description: "" schema: properties: snapshotpolicy: $ref: '#/definitions/SnapshotPolicyDetails' type: object snapshotpolicy_GetDetailsMetadataOutput: description: "" schema: properties: snapshotpolicy: additionalProperties: type: string type: object x-go-name: Output type: object snapshotpolicy_GetDetailsStatusOutput: description: "" schema: properties: snapshotpolicy: $ref: '#/definitions/GetDetailsStatusOutput' type: object snapshotpolicy_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset snapshotpolicies: items: $ref: '#/definitions/SnapshotPolicyDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object snapshotpolicy_PerformBindDisksOutput: description: "" snapshotpolicy_PerformBindResourcesOutput: description: "" snapshotpolicy_PerformChangeOwnerOutput: description: "" snapshotpolicy_PerformSyncstatusOutput: description: "" snapshotpolicy_PerformUnbindDisksOutput: description: "" snapshotpolicy_PerformUnbindResourcesOutput: description: "" snapshotpolicy_ValidateCreateDataOutput: description: "" schema: properties: snapshotpolicy: $ref: '#/definitions/SnapshotPolicyDetails' type: object snapshotpolicy_ValidateUpdateDataOutput: description: "" schema: properties: snapshotpolicy: $ref: '#/definitions/SnapshotPolicyDetails' type: object sslcertificate_CustomizeDeleteOutput: description: "" schema: properties: sslcertificate: $ref: '#/definitions/SSLCertificateDetails' type: object sslcertificate_FetchCustomizeColumnsOutput: description: "" schema: properties: sslcertificate: $ref: '#/definitions/SSLCertificateDetails' type: object sslcertificate_GetDetailsMetadataOutput: description: "" schema: properties: sslcertificate: additionalProperties: type: string type: object x-go-name: Output type: object sslcertificate_GetDetailsStatusOutput: description: "" schema: properties: sslcertificate: $ref: '#/definitions/GetDetailsStatusOutput' type: object sslcertificate_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset sslcertificates: items: $ref: '#/definitions/SSLCertificateDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object sslcertificate_PerformChangeOwnerOutput: description: "" sslcertificate_ValidateCreateDataOutput: description: "" schema: properties: sslcertificate: $ref: '#/definitions/SSLCertificateDetails' type: object sslcertificate_ValidateUpdateDataOutput: description: "" schema: properties: sslcertificate: $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_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_GetDetailsStatusOutput: description: "" schema: properties: storage: $ref: '#/definitions/GetDetailsStatusOutput' type: object 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_PerformDisableOutput: description: "" storage_PerformEnableOutput: description: "" storage_PerformForceDetachHostOutput: description: "" storage_PerformOfflineOutput: description: "" storage_PerformOnlineOutput: description: "" storage_PerformPrivateOutput: description: "" storage_PerformPublicOutput: description: "" storage_PerformSetCommitBoundOutput: description: "" storage_PerformSetHardwareInfoOutput: description: "" schema: properties: storage: $ref: '#/definitions/StorageHardwareInfo' type: object storage_PerformSetSchedtagOutput: 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_GetDetailsMetadataOutput: description: "" schema: properties: storagecache: additionalProperties: type: string type: object x-go-name: Output type: object 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_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_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_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_GetDetailsMetadataOutput: 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_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_PerformChangeOwnerOutput: description: "" tablestore_ValidateCreateDataOutput: description: "" schema: properties: tablestore: $ref: '#/definitions/TablestoreDetails' type: object tablestore_ValidateUpdateDataOutput: description: "" schema: properties: tablestore: $ref: '#/definitions/TablestoreDetails' type: object tap_flow_CustomizeDeleteOutput: description: "" schema: properties: tap_flow: $ref: '#/definitions/NetTapFlowDetails' type: object tap_flow_FetchCustomizeColumnsOutput: description: "" schema: properties: tap_flow: $ref: '#/definitions/NetTapFlowDetails' type: object tap_flow_GetDetailsMetadataOutput: description: "" schema: properties: tap_flow: additionalProperties: type: string type: object x-go-name: Output type: object tap_flow_GetDetailsStatusOutput: description: "" schema: properties: tap_flow: $ref: '#/definitions/GetDetailsStatusOutput' type: object tap_flow_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset tap_flows: items: $ref: '#/definitions/NetTapFlowDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object tap_flow_PerformDisableOutput: description: "" tap_flow_PerformEnableOutput: description: "" tap_flow_ValidateCreateDataOutput: description: "" schema: properties: tap_flow: $ref: '#/definitions/NetTapFlowDetails' type: object tap_flow_ValidateUpdateDataOutput: description: "" schema: properties: tap_flow: $ref: '#/definitions/NetTapFlowDetails' type: object tap_service_CustomizeDeleteOutput: description: "" schema: properties: tap_service: $ref: '#/definitions/NetTapServiceDetails' type: object tap_service_FetchCustomizeColumnsOutput: description: "" schema: properties: tap_service: $ref: '#/definitions/NetTapServiceDetails' type: object tap_service_GetDetailsMetadataOutput: description: "" schema: properties: tap_service: additionalProperties: type: string type: object x-go-name: Output type: object tap_service_GetDetailsStatusOutput: description: "" schema: properties: tap_service: $ref: '#/definitions/GetDetailsStatusOutput' type: object tap_service_ListItemFilterOutput: description: "" schema: properties: limit: format: int64 type: integer x-go-name: Limit offset: format: int64 type: integer x-go-name: Offset tap_services: items: $ref: '#/definitions/NetTapServiceDetails' type: array x-go-name: Output total: format: int64 type: integer x-go-name: Total type: object tap_service_PerformDisableOutput: description: "" tap_service_PerformEnableOutput: description: "" tap_service_ValidateCreateDataOutput: description: "" schema: properties: tap_service: $ref: '#/definitions/NetTapServiceDetails' type: object tap_service_ValidateUpdateDataOutput: description: "" schema: properties: tap_service: $ref: '#/definitions/NetTapServiceDetails' 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_GetDetailsMetadataOutput: 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_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_PerformDisableOutput: description: "" vpc_PerformEnableOutput: description: "" vpc_PerformPrivateOutput: description: "" vpc_PerformPublicOutput: description: "" vpc_PerformPurgeOutput: 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_GetDetailsMetadataOutput: 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_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_PerformDisableOutput: description: "" vpc_peering_connection_PerformEnableOutput: description: "" vpc_peering_connection_PerformPrivateOutput: description: "" vpc_peering_connection_PerformPublicOutput: 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_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_GetDetailsStatusOutput: description: "" schema: properties: waf_instance: $ref: '#/definitions/GetDetailsStatusOutput' type: object 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_PerformDisableOutput: description: "" waf_instance_PerformEnableOutput: description: "" waf_instance_PerformPrivateOutput: description: "" waf_instance_PerformPublicOutput: description: "" waf_instance_PerformRemoteUpdateOutput: 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_GetDetailsMetadataOutput: 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_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_PerformPrivateOutput: description: "" waf_ip_set_PerformPublicOutput: 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_regexset_CustomizeDeleteOutput: description: "" schema: properties: waf_regexset: $ref: '#/definitions/WafRegexSetDetails' type: object waf_regexset_FetchCustomizeColumnsOutput: description: "" schema: properties: waf_regexset: $ref: '#/definitions/WafRegexSetDetails' type: object waf_regexset_GetDetailsMetadataOutput: description: "" schema: properties: waf_regexset: additionalProperties: type: string type: object x-go-name: Output type: object waf_regexset_GetDetailsStatusOutput: description: "" schema: properties: waf_regexset: $ref: '#/definitions/GetDetailsStatusOutput' type: object waf_regexset_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_regexsets: items: $ref: '#/definitions/WafRegexSetDetails' type: array x-go-name: Output type: object waf_regexset_PerformChangeOwnerOutput: description: "" waf_regexset_PerformPrivateOutput: description: "" waf_regexset_PerformPublicOutput: description: "" waf_regexset_ValidateCreateDataOutput: description: "" schema: properties: waf_regexset: $ref: '#/definitions/WafRegexSetDetails' type: object waf_regexset_ValidateUpdateDataOutput: description: "" schema: properties: waf_regexset: $ref: '#/definitions/WafRegexSetDetails' 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_GetDetailsMetadataOutput: 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_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_PerformDisableOutput: description: "" waf_rule_PerformEnableOutput: 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_GetDetailsMetadataOutput: 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_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_PerformPrivateOutput: description: "" waf_rule_group_PerformPublicOutput: 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_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_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_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 webapp_CustomizeDeleteOutput: description: "" schema: properties: webapp: $ref: '#/definitions/AppDetails' type: object webapp_FetchCustomizeColumnsOutput: description: "" schema: properties: webapp: $ref: '#/definitions/AppDetails' type: object webapp_GetDetailsBackupsOutput: description: "" schema: properties: webapp: $ref: '#/definitions/AppBackupOutput' type: object webapp_GetDetailsCertificatesOutput: description: "" schema: properties: webapp: $ref: '#/definitions/AppCertificateOutput' type: object webapp_GetDetailsCustomDomainsOutput: description: "" schema: properties: webapp: $ref: '#/definitions/AppDomainOutput' type: object webapp_GetDetailsHybirdConnectionsOutput: description: "" schema: properties: webapp: $ref: '#/definitions/AppHybirdConnectionOutput' type: object webapp_GetDetailsMetadataOutput: description: "" schema: properties: webapp: additionalProperties: type: string type: object x-go-name: Output type: object webapp_GetDetailsStatusOutput: description: "" schema: properties: webapp: $ref: '#/definitions/GetDetailsStatusOutput' type: object webapp_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 webapps: items: $ref: '#/definitions/AppDetails' type: array x-go-name: Output type: object webapp_PerformChangeOwnerOutput: description: "" webapp_PerformRemoteUpdateOutput: description: "" webapp_PerformSyncstatusOutput: description: "" webapp_ValidateCreateDataOutput: description: "" schema: properties: webapp: $ref: '#/definitions/AppDetails' type: object webapp_ValidateUpdateDataOutput: description: "" schema: properties: webapp: $ref: '#/definitions/AppDetails' type: object webappenvironment_CustomizeDeleteOutput: description: "" schema: properties: webappenvironment: $ref: '#/definitions/AppEnvironmentDetails' type: object webappenvironment_FetchCustomizeColumnsOutput: description: "" schema: properties: webappenvironment: $ref: '#/definitions/AppEnvironmentDetails' type: object webappenvironment_GetDetailsMetadataOutput: description: "" schema: properties: webappenvironment: additionalProperties: type: string type: object x-go-name: Output type: object webappenvironment_GetDetailsStatusOutput: description: "" schema: properties: webappenvironment: $ref: '#/definitions/GetDetailsStatusOutput' type: object webappenvironment_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 webappenvironments: items: $ref: '#/definitions/AppEnvironmentDetails' type: array x-go-name: Output type: object webappenvironment_PerformChangeOwnerOutput: description: "" webappenvironment_ValidateCreateDataOutput: description: "" schema: properties: webappenvironment: $ref: '#/definitions/AppEnvironmentDetails' type: object webappenvironment_ValidateUpdateDataOutput: description: "" schema: properties: webappenvironment: $ref: '#/definitions/AppEnvironmentDetails' 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_GetDetailsMetadataOutput: 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_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_PerformMergeFromOutput: description: "" wire_PerformMergeNetworkOutput: description: "" wire_PerformMergeToOutput: description: "" wire_PerformPrivateOutput: description: "" wire_PerformPublicOutput: description: "" wire_PerformSetClassMetadataOutput: 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_GetDetailsDiskCapabilityOutput: description: "" zone_GetDetailsMetadataOutput: 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_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_PerformPurgeOutput: description: "" zone_PerformSetSchedtagOutput: 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 securityDefinitions: keystone: in: header name: X-Auth-Token type: apiKey swagger: "2.0"