fix(docs): update api docs (#22626)

This commit is contained in:
屈轩
2025-05-29 12:00:51 +08:00
committed by GitHub
parent 289b62101f
commit c34fcd9f82
33 changed files with 156 additions and 599 deletions
+23 -33
View File
@@ -37,10 +37,6 @@ definitions:
user:rd: op
type: object
x-go-name: Metadata
cloudaccount_id:
description: 'swagger: ignore'
type: string
x-go-name: CloudaccountId
cloudpolicy_ids:
description: 权限Id列表, 权限provider必须和权限组provider一致
items:
@@ -1980,11 +1976,6 @@ paths:
name: status
type: array
x-go-name: Status
- description: 根据云账号名称过滤资源
in: query
name: cloudaccount
type: string
x-go-name: Cloudaccount
- description: 根据平台过滤
in: query
items:
@@ -1992,6 +1983,10 @@ paths:
name: provider
type: array
x-go-name: Provider
- in: query
name: cloudaccount_id
type: string
x-go-name: CloudaccountId
- description: 根据云订阅过滤资源
in: query
name: manager_id
@@ -2958,11 +2953,10 @@ paths:
name: status
type: array
x-go-name: Status
- description: 根据云账号名称过滤资源
in: query
name: cloudaccount
- in: query
name: cloudaccount_id
type: string
x-go-name: Cloudaccount
x-go-name: CloudaccountId
- description: 根据平台过滤
in: query
items:
@@ -3709,11 +3703,6 @@ paths:
name: status
type: array
x-go-name: Status
- description: 根据云账号名称过滤资源
in: query
name: cloudaccount
type: string
x-go-name: Cloudaccount
- description: 根据平台过滤
in: query
items:
@@ -3721,6 +3710,10 @@ paths:
name: provider
type: array
x-go-name: Provider
- in: query
name: cloudaccount_id
type: string
x-go-name: CloudaccountId
- description: 根据云订阅过滤资源
in: query
name: manager_id
@@ -4535,11 +4528,6 @@ paths:
name: user_id
type: string
x-go-name: UserId
- description: 根据云账号名称过滤资源
in: query
name: cloudaccount
type: string
x-go-name: Cloudaccount
- description: 根据平台过滤
in: query
items:
@@ -4547,6 +4535,10 @@ paths:
name: provider
type: array
x-go-name: Provider
- in: query
name: cloudaccount_id
type: string
x-go-name: CloudaccountId
- description: 根据云订阅过滤资源
in: query
name: manager_id
@@ -5504,11 +5496,6 @@ paths:
name: status
type: array
x-go-name: Status
- description: 根据云账号名称过滤资源
in: query
name: cloudaccount
type: string
x-go-name: Cloudaccount
- description: 根据平台过滤
in: query
items:
@@ -5516,6 +5503,10 @@ paths:
name: provider
type: array
x-go-name: Provider
- in: query
name: cloudaccount_id
type: string
x-go-name: CloudaccountId
- description: 根据云订阅过滤资源
in: query
name: manager_id
@@ -6280,11 +6271,6 @@ paths:
name: cloudgroup_id
type: string
x-go-name: CloudgroupId
- description: 根据云账号名称过滤资源
in: query
name: cloudaccount
type: string
x-go-name: Cloudaccount
- description: 根据平台过滤
in: query
items:
@@ -6292,6 +6278,10 @@ paths:
name: provider
type: array
x-go-name: Provider
- in: query
name: cloudaccount_id
type: string
x-go-name: CloudaccountId
responses:
"200":
$ref: '#/responses/samluser_ListItemFilterOutput'
+24 -395
View File
@@ -2141,78 +2141,15 @@ definitions:
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
CacheImageInput:
properties:
checksum:
description: 'swagger: ignore'
type: string
x-go-name: Checksum
format:
type: string
x-go-name: Format
image:
type: string
x-go-name: Image
image_id:
type: string
x-go-name: ImageId
image_name:
description: 'swagger: ignore'
type: string
x-go-name: ImageName
is_force:
type: boolean
x-go-name: IsForce
os_arch:
description: 'swagger: ignore'
type: string
x-go-name: OsArch
os_distribution:
description: 'swagger: ignore'
type: string
x-go-name: OsDistribution
os_full_version:
description: 'swagger: ignore'
type: string
x-go-name: OsFullVersion
os_type:
description: 'swagger: ignore'
type: string
x-go-name: OsType
os_version:
description: 'swagger: ignore'
type: string
x-go-name: OsVersion
parent_task_id:
description: 'swagger: ignore'
type: string
x-go-name: ParentTaskId
pre_cache:
description: 'swagger: ignore'
type: boolean
x-go-name: PreCache
server_id:
description: 'swagger: ignore'
type: string
x-go-name: ServerId
skip_checksum_if_exists:
description: 'swagger: ignore'
type: boolean
x-go-name: SkipChecksumIfExists
source_host_id:
description: 'swagger: ignore'
type: string
x-go-name: SourceHostId
src_url:
description: 'swagger: ignore'
type: string
x-go-name: SrcUrl
storagecache_id:
description: 'swagger: ignore'
type: string
x-go-name: StoragecacheId
zone:
description: 'swagger: ignore'
type: string
x-go-name: Zone
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
CachedImageManagerCacheImageInput:
@@ -7631,20 +7568,12 @@ definitions:
user:rd: op
type: object
x-go-name: Metadata
back_storage_id:
description: 'swagger: ignore'
type: string
x-go-name: BackStorageId
backup_as_tar:
$ref: '#/definitions/DiskBackupAsTarInput'
backup_storage_id:
description: 'description: backup storage id'
type: string
x-go-name: BackupStorageId
cloudregion_id:
description: 'swagger: ignore'
type: string
x-go-name: CloudregionId
description:
description: 资源描述
example: test create network
@@ -9048,9 +8977,6 @@ definitions:
properties:
Format:
type: string
ImageId:
description: 'swagger: ignore'
type: string
Name:
type: string
type: object
@@ -10928,11 +10854,6 @@ definitions:
- "18:00:00"
type: string
x-go-name: MaintainStartTime
memory_size_mb:
description: 'swagger: ignore'
format: int64
type: integer
x-go-name: MemorySizeMb
name:
description: |-
资源名称,如果generate_name为空,则为必填项
@@ -10941,10 +10862,6 @@ definitions:
type: string
uniqueItems: true
x-go-name: Name
network:
description: 'swagger: ignore'
type: string
x-go-name: Network
network_id:
description: Ip子网名称或Id,建议使用Id
type: string
@@ -10998,10 +10915,6 @@ definitions:
description: 用来存储资源的状态
type: string
x-go-name: Status
zone:
description: 'swagger: ignore'
type: string
x-go-name: Zone
zone_id:
description: 主可用区名称或Id
type: string
@@ -12494,12 +12407,6 @@ definitions:
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
@@ -13555,10 +13462,6 @@ definitions:
format: int64
type: integer
x-go-name: MaxBandwidthMb
prefer_host:
description: 'swagger: ignore'
type: string
x-go-name: PreferHost
prefer_host_id:
description: 指定期望的迁移目标宿主机
type: string
@@ -13607,10 +13510,6 @@ definitions:
auto_start:
type: boolean
x-go-name: AutoStart
prefer_host:
description: 'swagger: ignore'
type: string
x-go-name: PreferHost
prefer_host_id:
type: string
x-go-name: PreferHostId
@@ -15633,10 +15532,6 @@ definitions:
x-go-name: Mac
net_type:
$ref: '#/definitions/TNetworkType'
network:
description: Deprecated
type: string
x-go-name: Network
network_id:
type: string
x-go-name: NetworkId
@@ -19420,10 +19315,6 @@ definitions:
x-go-name: Name
network_ids:
$ref: '#/definitions/SKubeNetworkIds'
public_key:
description: 'swagger: ignore'
type: string
x-go-name: PublicKey
root_disk_size_gb:
format: int64
type: integer
@@ -20159,14 +20050,6 @@ definitions:
address:
type: string
x-go-name: Address
backend:
description: 'swagger: ignore'
type: string
x-go-name: Backend
backend_group:
description: 'swagger: ignore'
type: string
x-go-name: BackendGroup
backend_group_id:
type: string
x-go-name: BackendGroupId
@@ -20552,10 +20435,6 @@ definitions:
description: the resource is an emulated resource
type: boolean
x-go-name: IsEmulated
loadbalancer:
description: 'swagger: ignore'
type: string
x-go-name: Loadbalancer
loadbalancer_id:
description: 负载均衡ID
type: string
@@ -20865,10 +20744,6 @@ definitions:
description: 区域名称或ID
type: string
x-go-name: CloudregionId
common_name:
description: 'swagger: ignore'
type: string
x-go-name: CommonName
description:
description: 资源描述
example: test create network
@@ -20879,10 +20754,6 @@ definitions:
description: 预检验参数,若为true则仅检查参数,并不真正创建变更
type: boolean
x-go-name: DryRun
fingerprint:
description: 'swagger: ignore'
type: string
x-go-name: Fingerprint
generate_name:
description: |-
生成资源名称的模板,如果name为空,则为必填项
@@ -20912,16 +20783,6 @@ definitions:
type: string
uniqueItems: true
x-go-name: Name
not_after:
description: 'swagger: ignore'
format: date-time
type: string
x-go-name: NotAfter
not_before:
description: 'swagger: ignore'
format: date-time
type: string
x-go-name: NotBefore
private_key:
type: string
x-go-name: PrivateKey
@@ -20933,31 +20794,14 @@ definitions:
description: 指定项目的名称或ID
type: string
x-go-name: ProjectId
public_key_algorithm:
description: 'swagger: ignore'
type: string
x-go-name: PublicKeyAlgorithm
public_key_bit_len:
description: 'swagger: ignore'
format: int64
type: integer
x-go-name: PublicKeyBitLen
public_scope:
description: 共享范围
type: string
x-go-name: PublicScope
signature_algorithm:
description: 'swagger: ignore'
type: string
x-go-name: SignatureAlgorithm
status:
description: 用来存储资源的状态
type: string
x-go-name: Status
subject_alternative_names:
description: 'swagger: ignore'
type: string
x-go-name: SubjectAlternativeNames
required:
- name
type: object
@@ -21435,13 +21279,6 @@ definitions:
user:rd: op
type: object
x-go-name: Metadata
Networks:
description: |-
多子网
swagger: ignore
items:
type: string
type: array
address:
description: IP地址
type: string
@@ -21485,10 +21322,6 @@ definitions:
format: int64
type: integer
x-go-name: EgressMbps
eip:
description: 'swagger: ignore'
type: string
x-go-name: Eip
eip_auto_dellocate:
description: 是否跟随主机删除而自动释放
type: boolean
@@ -21987,10 +21820,6 @@ definitions:
user:rd: op
type: object
x-go-name: Metadata
acl:
description: 'swagger: ignore'
type: string
x-go-name: Acl
acl_id:
type: string
x-go-name: AclId
@@ -22006,10 +21835,6 @@ definitions:
format: int64
type: integer
x-go-name: BackendConnectTimeout
backend_group:
description: 'swagger: ignore'
type: string
x-go-name: BackendGroup
backend_group_id:
type: string
x-go-name: BackendGroupId
@@ -22019,10 +21844,6 @@ definitions:
format: int64
type: integer
x-go-name: BackendIdleTimeout
certificate:
description: 'swagger: ignore'
type: string
x-go-name: Certificate
certificate_id:
type: string
x-go-name: CertificateId
@@ -22132,10 +21953,6 @@ definitions:
listener_type:
type: string
x-go-name: ListenerType
loadbalancer:
description: 'swagger: ignore'
type: string
x-go-name: Loadbalancer
loadbalancer_id:
description: 负载均衡ID
type: string
@@ -22662,10 +22479,6 @@ definitions:
description: the resource is an emulated resource
type: boolean
x-go-name: IsEmulated
listener:
description: 'swagger: ignore'
type: string
x-go-name: Listener
listener_id:
type: string
x-go-name: ListenerId
@@ -23050,10 +22863,6 @@ definitions:
format: int64
type: integer
x-go-name: HttpRequstRatePerSec
listener:
description: 'swagger: ignore'
type: string
x-go-name: Listener
listener_id:
type: string
x-go-name: ListenerId
@@ -23072,10 +22881,6 @@ definitions:
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
LoadbalancerListenerUpdateInput:
properties:
acl:
description: 'swagger: ignore'
type: string
x-go-name: Acl
acl_id:
type: string
x-go-name: AclId
@@ -23097,10 +22902,6 @@ definitions:
format: int64
type: integer
x-go-name: BackendIdleTimeout
certificate:
description: 'swagger: ignore'
type: string
x-go-name: Certificate
certificate_id:
type: string
x-go-name: CertificateId
@@ -26350,11 +26151,6 @@ definitions:
description: 用来存储资源的状态
type: string
x-go-name: Status
vlan:
description: deprecated
format: int64
type: integer
x-go-name: Vlan
vlan_id:
description: VlanId
format: int64
@@ -30811,16 +30607,10 @@ definitions:
eip:
type: string
x-go-name: Eip
external_ip_id:
type: string
x-go-name: ExternalIpId
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
SNatSCreateInput:
properties:
Ip:
description: 'swagger: ignore'
type: string
Name:
type: string
NatgatewayId:
@@ -31496,14 +31286,6 @@ definitions:
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
@@ -31525,10 +31307,6 @@ definitions:
example: test###
type: string
x-go-name: GenerateName
globalvpc_id:
description: 'swagger: ignore'
type: string
x-go-name: GlobalvpcId
is_emulated:
description: |-
资源是否为模拟资源
@@ -31645,10 +31423,6 @@ definitions:
description: 安全组ID
type: string
x-go-name: SecgroupId
status:
description: 'swagger: ignore'
type: string
x-go-name: Status
required:
- priority
- protocol
@@ -32360,19 +32134,11 @@ definitions:
user:rd: op
type: object
x-go-name: Metadata
backend_group_id:
description: 'swagger: ignore'
type: string
x-go-name: BackendGroupId
cloudregion:
description: 'description: cloud region id or name'
example: cr-test-one
type: string
x-go-name: Cloudregion
cloudregion_id:
description: 'swagger: ignore'
type: string
x-go-name: CloudregionId
description:
description: 资源描述
example: test create network
@@ -32420,10 +32186,6 @@ definitions:
example: gt-test-one
type: string
x-go-name: GuestTemplate
guest_template_id:
description: 'swagger: ignore'
type: string
x-go-name: GuestTemplateId
health_check_cycle:
description: 'description: 健康检查周期'
example: 300
@@ -33000,10 +32762,6 @@ definitions:
example: sg-test-one
type: string
x-go-name: ScalingGroup
scaling_group_id:
description: 'swagger: ignore'
type: string
x-go-name: ScalingGroupId
status:
description: 用来存储资源的状态
type: string
@@ -33294,10 +33052,6 @@ definitions:
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
SchedtagConfig:
properties:
id:
description: 'swagger: ignore'
type: string
x-go-name: Id
resource_type:
description: |-
资源类型
@@ -33317,11 +33071,6 @@ definitions:
enmu: required, prefer, avoid, exclude
type: string
x-go-name: Strategy
weight:
description: 'swagger: ignore'
format: int64
type: integer
x-go-name: Weight
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
SchedtagCreateInput:
@@ -34247,20 +33996,12 @@ definitions:
format: int64
type: integer
x-go-name: ExtraCpuCount
flavor:
description: 'swagger: ignore'
type: string
x-go-name: Flavor
instance_type:
description: |-
关机且停机不收费情况下不允许调整配置
实例类型, 优先级高于vcpu_count和vmem_size
type: string
x-go-name: InstanceType
sku:
description: 'swagger: ignore'
type: string
x-go-name: Sku
vcpu_count:
description: cpu大小
format: int64
@@ -34526,12 +34267,6 @@ definitions:
format: int64
type: integer
x-go-name: ExtraCpuCount
fake_create:
description: |-
swagger: ignore
创建测试数据,不实际创建资源
type: boolean
x-go-name: FakeCreate
generate_name:
description: |-
生成资源名称的模板,如果name为空,则为必填项
@@ -34694,10 +34429,6 @@ definitions:
description: 指定项目的名称或ID
type: string
x-go-name: ProjectId
provider:
description: 'swagger: ignore'
type: string
x-go-name: Provider
public_ip_bw:
description: |-
公网IP带宽(单位MB)
@@ -34849,28 +34580,10 @@ definitions:
若指定的秘钥Id和虚拟机的秘钥Id不相同, 则清理旧的公钥
type: string
x-go-name: DeletePublicKey
deploy_configs:
description: 'swagger: ignore'
items:
$ref: '#/definitions/DeployConfig'
type: array
x-go-name: DeployConfigs
deploy_telegraf:
description: 'swagger: ignore'
type: boolean
x-go-name: DeployTelegraf
keypair:
description: 'swagger: ignore'
type: string
x-go-name: Keypair
keypair_id:
description: 秘钥Id
type: string
x-go-name: KeypairId
login_account:
description: 'swagger: ignore'
type: string
x-go-name: LoginAccount
password:
description: 重置指定密码
type: string
@@ -34879,10 +34592,6 @@ definitions:
description: 生成随机密码, 优先级低于password
type: boolean
x-go-name: ResetPassword
restart:
description: 'swagger: ignore'
type: boolean
x-go-name: Restart
user_data:
description: |-
用户自定义启动脚本
@@ -35821,10 +35530,6 @@ definitions:
live_migrate:
type: boolean
x-go-name: LiveMigrate
prefer_host:
description: Deprecated
type: string
x-go-name: PreferHost
prefer_host_id:
type: string
x-go-name: PreferHostId
@@ -35934,38 +35639,16 @@ definitions:
若指定的秘钥Id和虚拟机的秘钥Id不相同, 则清理旧的公钥
type: string
x-go-name: DeletePublicKey
deploy_configs:
description: 'swagger: ignore'
items:
$ref: '#/definitions/DeployConfig'
type: array
x-go-name: DeployConfigs
deploy_telegraf:
description: 'swagger: ignore'
type: boolean
x-go-name: DeployTelegraf
image:
description: 'swagger: ignore'
type: string
x-go-name: Image
image_id:
description: |-
关机且停机不收费情况下不允许重装系统
镜像 id
type: string
x-go-name: ImageId
keypair:
description: 'swagger: ignore'
type: string
x-go-name: Keypair
keypair_id:
description: 秘钥Id
type: string
x-go-name: KeypairId
login_account:
description: 'swagger: ignore'
type: string
x-go-name: LoginAccount
password:
description: 重置指定密码
type: string
@@ -35974,10 +35657,6 @@ definitions:
description: 生成随机密码, 优先级低于password
type: boolean
x-go-name: ResetPassword
restart:
description: 'swagger: ignore'
type: boolean
x-go-name: Restart
user_data:
description: |-
用户自定义启动脚本
@@ -36014,10 +35693,6 @@ definitions:
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
ServerResizeDiskInput:
properties:
disk:
description: 'swagger: ignore'
type: string
x-go-name: Disk
disk_id:
description: 磁盘Id
type: string
@@ -36146,9 +35821,6 @@ definitions:
type: string
GenerateName:
type: string
ImageId:
description: 'swagger: ignore'
type: string
IsPublic:
type: boolean
Name:
@@ -36156,15 +35828,6 @@ definitions:
type: string
Notes:
type: string
OsArch:
description: 'swagger: ignore'
type: string
OsType:
description: 'swagger: ignore'
type: string
Restart:
description: 'swagger: ignore'
type: boolean
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
ServerSetBootIndexInput:
@@ -36779,11 +36442,6 @@ definitions:
format: float
type: number
x-go-name: Progress
progress_mbps:
description: 'swagger: ignore'
format: float
type: number
x-go-name: ProgressMbps
shutdown_behavior:
description: 关机执行操作
type: string
@@ -40103,12 +39761,6 @@ definitions:
type: string
type: array
x-go-name: Resources
skip_sync_resources:
description: 'swagger: ignore'
items:
type: string
type: array
x-go-name: SkipSyncResources
xor:
description: 极速模式(差量更新)
type: boolean
@@ -42205,12 +41857,6 @@ definitions:
description: WAF实例Id
type: string
x-go-name: WafInstanceId
waf_rule_group_id:
description: |-
swagger: ignore
WAF规则组Id
type: string
x-go-name: WafRuleGroupId
required:
- name
type: object
@@ -42597,11 +42243,6 @@ definitions:
format: int64
type: integer
x-go-name: Bandwidth
bw:
description: Deprecated
format: int64
type: integer
x-go-name: Bw
description:
description: 资源描述
example: test create network
@@ -120694,18 +120335,18 @@ paths:
name: refresh
type: boolean
x-go-name: Refresh
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
- description: 配额所属范围,可能值为projects和domains,分别代表项目的配额和域的配额
in: path
name: scope
required: true
type: string
x-go-name: Scope
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
responses:
"200":
$ref: '#/responses/models_GetProjectQuotaOutput'
@@ -120716,18 +120357,18 @@ paths:
description: 设置指定项目或者域的项目配额
operationId: models_SetProjectQuotas
parameters:
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
- description: 配额所属范围,可能值为projects和domains,分别代表项目的配额和域的配额
in: path
name: scope
required: true
type: string
x-go-name: Scope
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
- in: body
name: body
schema:
@@ -120814,18 +120455,18 @@ paths:
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
- description: 配额所属范围,可能值为projects和domains,分别代表项目的配额和域的配额
in: path
name: scope
required: true
type: string
x-go-name: Scope
- in: body
name: body
schema:
@@ -120912,18 +120553,18 @@ paths:
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
- description: 配额所属范围,可能值为projects和domains,分别代表项目的配额和域的配额
in: path
name: scope
required: true
type: string
x-go-name: Scope
- in: body
name: body
schema:
@@ -132163,11 +131804,6 @@ paths:
name: order_by_ip
type: string
x-go-name: OrderByIp
- description: 根据ip查找机器
in: query
name: ip_addr
type: string
x-go-name: IpAddr
- description: 根据多个ip查找机器
in: query
items:
@@ -132185,13 +131821,6 @@ paths:
name: attachable_servers_for_disk
type: string
x-go-name: AttachableServersForDisk
- description: |-
Deprecated
列出可以挂载磁盘的主机
in: query
name: disk
type: string
x-go-name: Disk
- description: 按主机资源类型进行排序
enum:
- shared
-18
View File
@@ -1535,17 +1535,6 @@ definitions:
type: string
type: array
x-go-name: Key
keys:
description: |-
keys
swagger: ignore
type: string
x-go-name: Keys
level:
description: 'swagger: ignore'
format: int64
type: integer
x-go-name: Level
name:
description: |-
资源名称,如果generate_name为空,则为必填项
@@ -9392,13 +9381,6 @@ paths:
name: role_id
type: string
x-go-name: RoleId
- description: |-
swagger: ignore
Deprecated
in: query
name: role
type: string
x-go-name: Role
responses:
"200":
$ref: '#/responses/policy_ListItemFilterOutput'
+6 -6
View File
@@ -2145,18 +2145,18 @@ paths:
name: refresh
type: boolean
x-go-name: Refresh
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
- description: 配额所属范围,可能值为projects和domains,分别代表项目的配额和域的配额
in: path
name: scope
required: true
type: string
x-go-name: Scope
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
responses:
"200":
$ref: '#/responses/models_GetImageQuotaOutput'
-52
View File
@@ -249,55 +249,11 @@ definitions:
type: string
type: array
x-go-name: Cc
content:
description: 'swagger: ignore'
type: object
x-go-name: Content
dest:
description: 'swagger: ignore'
type: string
x-go-name: Dest
dest_bcc:
description: 'swagger: ignore'
type: string
x-go-name: DestBcc
dest_cc:
description: 'swagger: ignore'
type: string
x-go-name: DestCc
domain:
description: 'swagger: ignore'
type: string
x-go-name: Domain
domain_id:
description: 'swagger: ignore'
type: string
x-go-name: DomainId
more_datails:
additionalProperties:
type: string
type: object
x-go-name: MoreDetails
project:
description: 'swagger: ignore'
type: string
x-go-name: Project
project_domain:
description: 'swagger: ignore'
type: string
x-go-name: ProjectDomain
project_domain_id:
description: 'swagger: ignore'
type: string
x-go-name: ProjectDomainId
project_id:
description: 'swagger: ignore'
type: string
x-go-name: ProjectId
roles:
description: 'swagger: ignore'
type: string
x-go-name: Roles
session_id:
type: string
x-go-name: SessionId
@@ -309,14 +265,6 @@ definitions:
type: string
type: array
x-go-name: To
user:
description: 'swagger: ignore'
type: string
x-go-name: User
user_id:
description: 'swagger: ignore'
type: string
x-go-name: UserId
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/notify
EmailQueueDetails:
+1 -1
View File
@@ -16,12 +16,12 @@ package cloudid
type CloudaccountResourceListInput struct {
// 根据云账号名称过滤资源
// swagger:ignore
Cloudaccount string `json:"cloudaccount" yunion-deprecated-by:"cloudaccount_id"`
// 根据平台过滤
Provider []string `json:"provider"`
// swagger:ignore
CloudaccountId string `json:"cloudaccount_id"`
}
+1 -1
View File
@@ -99,7 +99,7 @@ type CloudgroupCreateInput struct {
// 子账号Id
ManagerId string `json:"manager_id"`
// swagger: ignore
// swagger:ignore
CloudaccountId string `json:"cloudaccount_id"`
// 权限Id列表, 权限provider必须和权限组provider一致
+4 -4
View File
@@ -23,7 +23,7 @@ import (
type SchedtagConfig struct {
apis.Meta
// swagger: ignore
// swagger:ignore
Id string `json:"id"`
// 调度策略
// required: 必须使用
@@ -32,7 +32,7 @@ type SchedtagConfig struct {
// exclude: 禁止使用
// enmu: required, prefer, avoid, exclude
Strategy string `json:"strategy"`
// swagger: ignore
// swagger:ignore
Weight int `json:"weight"`
// 资源类型
// hosts: 宿主机
@@ -375,7 +375,7 @@ type ServerConfigs struct {
// default: kvm
Hypervisor string `json:"hypervisor"`
// swagger: ignore
// swagger:ignore
Provider string `json:"provider"`
// 包年包月资源池
@@ -488,7 +488,7 @@ type ServerCreateInput struct {
// required: false
UserData string `json:"user_data"`
// swagger: ignore
// swagger:ignore
// 创建测试数据,不实际创建资源
FakeCreate bool `json:"fake_create"`
+2 -2
View File
@@ -134,11 +134,11 @@ type DiskBackupCreateInput struct {
// description: disk id
DiskId string `json:"disk_id"`
// swagger: ignore
// swagger:ignore
BackStorageId string `json:"back_storage_id" yunion-deprecated-by:"backup_storage_id"`
// description: backup storage id
BackupStorageId string `json:"backup_storage_id"`
// swagger: ignore
// swagger:ignore
CloudregionId string `json:"cloudregion_id"`
// swagger:ignore
ManagerId string `json:"manager_id"`
+1 -1
View File
@@ -560,7 +560,7 @@ type SyncRangeInput struct {
Zone []string `json:"zone"`
Host []string `json:"host"`
// swagger: ignore
// swagger:ignore
SkipSyncResources []string `json:"skip_sync_resources"`
// 按资源类型同步,可输入多个
+1 -1
View File
@@ -277,7 +277,7 @@ type DiskSaveInput struct {
Name string
Format string
// swagger: ignore
// swagger:ignore
ImageId string
}
+3 -3
View File
@@ -183,7 +183,7 @@ type ElasticcacheCreateInput struct {
// 主可用区名称或Id
ZoneId string `json:"zone_id"`
// swagger: ignore
// swagger:ignore
Zone string `json:"zone" yunion-deprecated-by:"zone_id"`
// 备可用区名称或Id列表, split by: ,
@@ -196,7 +196,7 @@ type ElasticcacheCreateInput struct {
// required: true
NetworkId string `json:"network_id"`
// swagger: ignore
// swagger:ignore
Network string `json:"network" yunion-deprecated-by:"network_id"`
// 网络类型
@@ -219,7 +219,7 @@ type ElasticcacheCreateInput struct {
NodeType string `json:"node_type"`
// swagger: ignore
// swagger:ignore
MemorySizeMb int `json:"memory_size_mb" yunion-deprecated-by:"capacity_mb"`
// 初始密码
+20 -17
View File
@@ -83,6 +83,7 @@ type ServerListInput struct {
OrderByIp string `json:"order_by_ip"`
// 根据ip查找机器
// swagger:ignore
IpAddr string `json:"ip_addr" yunion-deprecated-by:"ip_addrs"`
// 根据多个ip查找机器
IpAddrs []string `json:"ip_addrs"`
@@ -94,6 +95,7 @@ type ServerListInput struct {
AttachableServersForDisk string `json:"attachable_servers_for_disk"`
// Deprecated
// 列出可以挂载磁盘的主机
// swagger:ignore
Disk string `json:"disk" yunion-deprecated-by:"attachable_servers_for_disk"`
// 按主机资源类型进行排序
@@ -141,13 +143,13 @@ func (input *ServerListInput) AfterUnmarshal() {
type ServerRebuildRootInput struct {
apis.Meta
// swagger: ignore
// swagger:ignore
Image string `json:"image" yunion-deprecated-by:"image_id"`
// 关机且停机不收费情况下不允许重装系统
// 镜像 id
// required: true
ImageId string `json:"image_id"`
// swagger: ignore
// swagger:ignore
// Keypair string `json:"keypair" yunion-deprecated-by:"keypair_id"`
// 秘钥Id
// KeypairId string `json:"keypair_id"`
@@ -512,7 +514,7 @@ type GuestSyncFixNicsInput struct {
}
type GuestMigrateInput struct {
// swagger: ignore
// swagger:ignore
PreferHost string `json:"prefer_host" yunion-deprecated-by:"prefer_host_id"`
PreferHostId string `json:"prefer_host_id"`
AutoStart bool `json:"auto_start"`
@@ -520,7 +522,7 @@ type GuestMigrateInput struct {
}
type GuestLiveMigrateInput struct {
// swagger: ignore
// swagger:ignore
PreferHost string `json:"prefer_host" yunion-deprecated-by:"prefer_host_id"`
// 指定期望的迁移目标宿主机
PreferHostId string `json:"prefer_host_id"`
@@ -660,16 +662,16 @@ type ServerSaveImageInput struct {
// 公有云若支持开机保存镜像,此参数则不生效
// default: false
AutoStart bool
// swagger: ignore
// swagger:ignore
Restart bool
// swagger: ignore
// swagger:ignore
OsType string
// swagger: ignore
// swagger:ignore
OsArch string
// swagger: ignore
// swagger:ignore
ImageId string
}
@@ -724,6 +726,7 @@ func (input ServerDetachnetworkInput) IsForce() bool {
type ServerMigrateForecastInput struct {
PreferHostId string `json:"prefer_host_id"`
// Deprecated
// swagger:ignore
PreferHost string `json:"prefer_host" yunion-deprecated-by:"prefer_host_id"`
LiveMigrate bool `json:"live_migrate"`
SkipCpuCheck bool `json:"skip_cpu_check"`
@@ -734,7 +737,7 @@ type ServerMigrateForecastInput struct {
}
type ServerResizeDiskInput struct {
// swagger: ignore
// swagger:ignore
Disk string `json:"disk" yunion-deprecated-by:"disk_id"`
// 磁盘Id
DiskId string `json:"disk_id"`
@@ -761,7 +764,7 @@ type ServerDeployInput struct {
}
type ServerDeployInputBase struct {
// swagger: ignore
// swagger:ignore
Keypair string `json:"keypair" yunion-deprecated-by:"keypair_id"`
// 秘钥Id
KeypairId string `json:"keypair_id"`
@@ -780,15 +783,15 @@ type ServerDeployInputBase struct {
// 支持特殊user data平台: Aliyun, Qcloud, Azure, Apsara, Ucloud
// required: false
UserData string `json:"user_data"`
// swagger: ignore
// swagger:ignore
LoginAccount string `json:"login_account"`
// swagger: ignore
// swagger:ignore
Restart bool `json:"restart"`
// swagger: ignore
// swagger:ignore
DeployConfigs []*DeployConfig `json:"deploy_configs"`
// swagger: ignore
// swagger:ignore
DeployTelegraf bool `json:"deploy_telegraf"`
}
@@ -814,9 +817,9 @@ type ServerChangeConfigInput struct {
// 关机且停机不收费情况下不允许调整配置
// 实例类型, 优先级高于vcpu_count和vmem_size
InstanceType string `json:"instance_type"`
// swagger: ignore
// swagger:ignore
Sku string `json:"sku" yunion-deprecated-by:"instance_type"`
// swagger: ignore
// swagger:ignore
Flavor string `json:"flavor" yunion-deprecated-by:"instance_type"`
// cpu卡槽数
@@ -862,7 +865,7 @@ type ServerUpdateInput struct {
SshPort int `json:"ssh_port"`
// swagger: ignore
// swagger:ignore
ProgressMbps float32 `json:"progress_mbps"`
}
+1
View File
@@ -654,6 +654,7 @@ type HostEnableNetifInput struct {
HostNetifInput
// Deprecated
// swagger:ignore
Network string `json:"network" yunion-deprecated-by:"network_id"`
NetworkId string `json:"network_id"`
+1 -1
View File
@@ -47,7 +47,7 @@ type KubeNodePoolCreateInput struct {
// 秘钥id,若不传,则使用系统级秘钥
KeypairId string `json:"keypair_id"`
// swagger: ignore
// swagger:ignore
PublicKey string `json:"public_key"`
}
+2 -2
View File
@@ -179,7 +179,7 @@ type LoadbalancerCreateInput struct {
// 是否跟随主机删除而自动释放
EipAutoDellocate bool `json:"eip_auto_dellocate,omitempty"`
// swagger: ignore
// swagger:ignore
Eip string `json:"eip" yunion-deprecated-by:"eip_id"`
// EIP Id
EipId string `json:"eip_id"`
@@ -206,7 +206,7 @@ type LoadbalancerCreateInput struct {
// Cloudregion string `json:"cloudregion"`
NetworkResourceInput
// 多子网
// swagger: ignore
// swagger:ignore
Networks []string
// Network string `json:"network"`
CloudproviderResourceInput
+2 -2
View File
@@ -53,11 +53,11 @@ type LoadbalancerBackendListInput struct {
type LoadbalancerBackendCreateInput struct {
apis.StatusStandaloneResourceCreateInput
//swagger: ignore
//swagger:ignore
BackendGroup string `json:"backend_group" yunion-deprecated-by:"backend_group_id"`
BackendGroupId string `json:"backend_group_id"`
//swagger: ignore
//swagger:ignore
Backend string `json:"backend" yunion-deprecated-by:"backend_id"`
BackendId string `json:"backend_id"`
+1 -1
View File
@@ -59,7 +59,7 @@ type LoadbalancerBackendGroupFilterListInput struct {
type LoadbalancerBackendGroupCreateInput struct {
apis.StatusStandaloneResourceCreateInput
//swagger: ignore
//swagger:ignore
Loadbalancer string `json:"loadbalancer" yunion-deprecated-by:"loadbalancer_id"`
// 负载均衡ID
LoadbalancerId string `json:"loadbalancer_id"`
+8 -8
View File
@@ -78,20 +78,20 @@ type LoadbalancerCertificateCreateInput struct {
Certificate string `json:"certificate"`
PrivateKey string `json:"private_key"`
// swagger: ignore
// swagger:ignore
Fingerprint string `json:"fingerprint"`
// swagger: ignore
// swagger:ignore
PublicKeyAlgorithm string `json:"public_key_algorithm"`
// swagger: ignore
// swagger:ignore
PublicKeyBitLen int `json:"public_key_bit_len"`
// swagger: ignore
// swagger:ignore
SignatureAlgorithm string `json:"signature_algorithm"`
// swagger: ignore
// swagger:ignore
NotBefore time.Time `json:"not_before"`
// swagger: ignore
// swagger:ignore
NotAfter time.Time `json:"not_after"`
// swagger: ignore
// swagger:ignore
CommonName string `json:"common_name"`
// swagger: ignore
// swagger:ignore
SubjectAlternativeNames string `json:"subject_alternative_names"`
}
+6 -6
View File
@@ -93,12 +93,12 @@ type LoadbalancerListenerListInput struct {
type LoadbalancerListenerCreateInput struct {
apis.StatusStandaloneResourceCreateInput
// swagger: ignore
// swagger:ignore
Loadbalancer string `json:"loadbalancer" yunion-deprecated-by:"loadbalancer_id"`
// 负载均衡ID
LoadbalancerId string `json:"loadbalancer_id"`
//swagger: ignore
//swagger:ignore
BackendGroup string `json:"backend_group" yunion-deprecated-by:"backend_group_id"`
BackendGroupId string `json:"backend_group_id"`
@@ -131,7 +131,7 @@ type LoadbalancerListenerCreateInput struct {
EgressMbps int `json:"egress_mbps"`
//swagger: ignore
//swagger:ignore
Certificate string `json:"certificate" yunion-deprecated-by:"certificate_id"`
CertificateId string `json:"certificate_id"`
@@ -173,7 +173,7 @@ type LoadbalancerListenerCreateInput struct {
RedirectHost string `json:"redirect_host"`
RedirectPath string `json:"redirect_path"`
//swagger: ignore
//swagger:ignore
Acl string `json:"acl" yunion-deprecated-by:"acl_id"`
AclId string `json:"acl_id"`
@@ -286,7 +286,7 @@ type LoadbalancerListenerUpdateInput struct {
AclStatus *string `json:"acl_status"`
AclType *string `json:"acl_type"`
//swagger: ignore
//swagger:ignore
Acl *string `json:"acl" yunion-deprecated-by:"acl_id"`
AclId *string `json:"acl_id"`
@@ -313,7 +313,7 @@ type LoadbalancerListenerUpdateInput struct {
XForwardedFor *bool `json:"x_forwarded_for"`
Gzip *bool `json:"gzip"`
//swagger: ignore
//swagger:ignore
Certificate *string `json:"certificate" yunion-deprecated-by:"certificate_id"`
CertificateId *string `json:"certificate_id"`
+2 -2
View File
@@ -53,7 +53,7 @@ type LoadbalancerListenerRuleListInput struct {
type LoadbalancerListenerRuleCreateInput struct {
apis.StatusStandaloneResourceCreateInput
// swagger: ignore
// swagger:ignore
Listener string `json:"listener" yunion-deprecated-by:"listener_id"`
ListenerId string `json:"listener_id"`
@@ -122,7 +122,7 @@ func (self *LoadbalancerListenerRuleCreateInput) Validate() error {
type LoadbalancerListenerRuleUpdateInput struct {
apis.StatusStandaloneResourceBaseUpdateInput
// swagger: ignore
// swagger:ignore
Listener string `json:"listener" yunion-deprecated-by:"listener_id"`
ListenerId string `json:"listener_id"`
+2 -1
View File
@@ -22,7 +22,7 @@ type SNatSCreateInput struct {
Name string
NatgatewayId string
NetworkId string
// swagger: ignore
// swagger:ignore
Ip string
// swagger:ignore
@@ -40,6 +40,7 @@ type SNatDCreateInput struct {
InternalPort int
ExternalIp string
Eip string `json:"eip"`
// swagger:ignore
ExternalIpId string `json:"external_ip_id" yunion-deprecated-by:"eip"`
ExternalPort int
IpProtocol string
+1
View File
@@ -264,6 +264,7 @@ type NetworkCreateInput struct {
VlanId *int `json:"vlan_id"`
// deprecated
// swagger:ignore
Vlan *int `json:"vlan" yunion-deprecated-by:"vlan_id"`
// 线路类型
+3 -3
View File
@@ -26,7 +26,7 @@ type ScalingGroupCreateInput struct {
// example: cr-test-one
Cloudregion string `json:"cloudregion"`
//swagger: ignore
//swagger:ignore
CloudregionId string `json:"cloudregion_id"`
// description: hypervisor
@@ -53,7 +53,7 @@ type ScalingGroupCreateInput struct {
// example: gt-test-one
GuestTemplate string `json:"guest_template"`
// swagger: ignore
// swagger:ignore
GuestTemplateId string `json:"guest_template_id"`
// description: 扩容策略
@@ -84,7 +84,7 @@ type ScalingGroupCreateInput struct {
// example: lbg-nihao
LbBackendGroup string `json:"lb_backend_group"`
// swagger: ignore
// swagger:ignore
BackendGroupId string `json:"backend_group_id"`
// description: 负载均衡后端服务器统一端口
+1 -1
View File
@@ -36,7 +36,7 @@ type ScalingPolicyCreateInput struct {
// example: sg-test-one
ScalingGroup string `json:"scaling_group"`
// swagger: ignore
// swagger:ignore
ScalingGroupId string `json:"scaling_group_id"`
// description: trigger type
+4 -4
View File
@@ -92,7 +92,7 @@ type SSecgroupRuleCreateInput struct {
// swagger:ignore
Secgroup string `json:"secgroup" yunion-deprecated-by:"secgroup_id"`
// swagger: ignore
// swagger:ignore
Status string `json:"status"`
// 安全组ID
@@ -176,12 +176,12 @@ type SSecgroupCreateInput struct {
// vpc id
// defualt: default
VpcResourceInput
// swagger: ignore
// swagger:ignore
CloudproviderResourceInput
// swagger: ignore
// swagger:ignore
CloudregionResourceInput
// swagger: ignore
// swagger:ignore
GlobalvpcId string `json:"globalvpc_id"`
// 规则列表
+17 -16
View File
@@ -49,49 +49,50 @@ type StoragecacheListInput struct {
type UncacheImageInput struct {
// 镜像ID
ImageId string `json:"image_id"`
// swagger: ignore
// swagger:ignore
StoragecacheId string `json:"storagecache_id"`
DeactivateImage *bool `json:"deactivate_image"`
}
type CacheImageInput struct {
// swagger:ignore
Image string `json:"image" yunion-deprecated-by:"image_id"`
ImageId string `json:"image_id"`
IsForce bool `json:"is_force"`
Format string `json:"format"`
// swagger: ignore
// swagger:ignore
Zone string `json:"zone"`
// swagger: ignore
// swagger:ignore
OsType string `json:"os_type"`
// swagger: ignore
// swagger:ignore
OsArch string `json:"os_arch"`
// swagger: ignore
// swagger:ignore
OsDistribution string `json:"os_distribution"`
// swagger: ignore
// swagger:ignore
OsFullVersion string `json:"os_full_version"`
// swagger: ignore
// swagger:ignore
OsVersion string `json:"os_version"`
// swagger: ignore
// swagger:ignore
ImageName string `json:"image_name"`
// swagger: ignore
// swagger:ignore
ServerId string `json:"server_id"`
// swagger: ignore
// swagger:ignore
ParentTaskId string `json:"parent_task_id"`
// swagger: ignore
// swagger:ignore
SourceHostId string `json:"source_host_id"`
// swagger: ignore
// swagger:ignore
SrcUrl string `json:"src_url"`
// swagger: ignore
// swagger:ignore
StoragecacheId string `json:"storagecache_id"`
// swagger: ignore
// swagger:ignore
Checksum string `json:"checksum"`
// swagger: ignore
// swagger:ignore
SkipChecksumIfExists bool `json:"skip_checksum_if_exists"`
// swagger: ignore
// swagger:ignore
PreCache bool `json:"pre_cache"`
}
+1 -1
View File
@@ -56,7 +56,7 @@ type WafRuleCreateInput struct {
// enmu: and, or, not
StatementCondition string `json:"statement_condition"`
// swagger: ignore
// swagger:ignore
// WAF规则组Id
WafRuleGroupId string `json:"waf_rule_group_id"`
+1
View File
@@ -24,6 +24,7 @@ type WireCreateInput struct {
Bandwidth int `json:"bandwidth"`
// Deprecated
// swagger:ignore
Bw int `json:"bw" yunion-deprecated-by:"bandwidth"`
// mtu
+1 -1
View File
@@ -909,7 +909,7 @@ type SExternalProject struct {
// 优先级,同一个本地项目映射多个云上项目,优先级高的优先选择
// 数值越高,优先级越大
Priority int `json:"priority"`
// swagger: ignore
// swagger:ignore
// 将在3.12之后版本移除
CloudaccountId string `json:"cloudaccount_id"`
}
+1 -1
View File
@@ -369,7 +369,7 @@ type PolicyListInput struct {
// filter policies by role id
RoleId string `json:"role_id"`
// swagger: ignore
// swagger:ignore
// Deprecated
Role string `json:"role" yunion-deprecated-by:"role_id"`
}
+2 -2
View File
@@ -79,14 +79,14 @@ type OrganizationCreateInput struct {
Type TOrgType `json:"type"`
// swagger: ignore
// swagger:ignore
Level int `json:"level,omitzero"`
// key
Key []string `json:"key"`
// keys
// swagger: ignore
// swagger:ignore
Keys string `json:"keys"`
}
+13 -13
View File
@@ -51,32 +51,32 @@ type SEmailConfig struct {
type EmailQueueCreateInput struct {
SEmailMessage
// swagger: ignore
// swagger:ignore
Dest string `json:"dest"`
// swagger: ignore
// swagger:ignore
DestCc string `json:"dest_cc"`
// swagger: ignore
// swagger:ignore
DestBcc string `json:"dest_bcc"`
// swagger: ignore
// swagger:ignore
Content jsonutils.JSONObject `json:"content"`
// swagger: ignore
// swagger:ignore
ProjectId string `json:"project_id"`
// swagger: ignore
// swagger:ignore
Project string `json:"project"`
// swagger: ignore
// swagger:ignore
ProjectDomainId string `json:"project_domain_id"`
// swagger: ignore
// swagger:ignore
ProjectDomain string `json:"project_domain"`
// swagger: ignore
// swagger:ignore
UserId string `json:"user_id"`
// swagger: ignore
// swagger:ignore
User string `json:"user"`
// swagger: ignore
// swagger:ignore
DomainId string `json:"domain_id"`
// swagger: ignore
// swagger:ignore
Domain string `json:"domain"`
// swagger: ignore
// swagger:ignore
Roles string `json:"roles"`
MoreDetails map[string]string `json:"more_datails"`