From cbe6216da28b41e485169b35372c8287fde280f3 Mon Sep 17 00:00:00 2001 From: ioito Date: Fri, 2 Jun 2023 16:35:26 +0800 Subject: [PATCH] fix(region): swagger api update --- docs/README.md | 20 - docs/ansibleplaybook/ansibleplaybook-run.yaml | 21 - .../ansibleplaybook/ansibleplaybook-stop.yaml | 20 - docs/ansibleplaybook/ansibleplaybook.yaml | 41 - docs/ansibleplaybook/ansibleplaybooks.yaml | 23 - docs/bucket/access.yaml | 11 - docs/bucket/acl.yaml | 32 - docs/bucket/bucket.yaml | 40 - docs/bucket/buckets.yaml | 32 - docs/bucket/deleteobjects.yaml | 16 - docs/bucket/limit.yaml | 16 - docs/bucket/listobjects.yaml | 13 - docs/bucket/makedir.yaml | 14 - docs/bucket/tempurl.yaml | 16 - docs/bucket/uploadobject.yaml | 14 - docs/build/build-host-image.md | 61 - docs/cloudaccount/change-project.yaml | 16 - docs/cloudaccount/cloudaccount.yaml | 40 - docs/cloudaccount/cloudaccounts.yaml | 30 - docs/cloudaccount/disable-auto-sync.yaml | 12 - docs/cloudaccount/disable.yaml | 12 - docs/cloudaccount/enable-auto-sync.yaml | 17 - docs/cloudaccount/enable.yaml | 12 - docs/cloudaccount/private.yaml | 12 - docs/cloudaccount/public.yaml | 13 - docs/cloudaccount/sync.yaml | 16 - docs/cloudaccount/update-credential.yaml | 16 - docs/dbinstance/change-config.yaml | 16 - docs/dbinstance/dbinstance.yaml | 24 - docs/dbinstance/dbinstanceaccount.yaml | 23 - docs/dbinstance/dbinstanceaccounts.yaml | 30 - docs/dbinstance/dbinstancebackup.yaml | 23 - docs/dbinstance/dbinstancebackups.yaml | 16 - docs/dbinstance/dbinstancedatabase.yaml | 23 - docs/dbinstance/dbinstancedatabases.yaml | 14 - docs/dbinstance/dbinstancenetwork.yaml | 12 - docs/dbinstance/dbinstancenetworks.yaml | 13 - docs/dbinstance/dbinstanceparameter.yaml | 23 - docs/dbinstance/dbinstanceparameters.yaml | 14 - docs/dbinstance/dbinstances.yaml | 36 - docs/dbinstance/public-connection.yaml | 16 - docs/dbinstance/purge.yaml | 12 - docs/dbinstance/reboot.yaml | 12 - docs/dbinstance/recovery.yaml | 17 - docs/dbinstance/sync-status.yaml | 11 - docs/dbinstance_sku/dbinstance_sku.yaml | 12 - docs/dbinstance_sku/dbinstance_skus.yaml | 15 - docs/dbinstanceaccount/account.yaml | 23 - docs/dbinstanceaccount/accounts.yaml | 30 - docs/dbinstanceaccount/grant-privilege.yaml | 17 - docs/dbinstanceaccount/reset-password.yaml | 17 - docs/dbinstanceaccount/revoke-privilege.yaml | 17 - docs/dbinstanceaccount/set-privileges.yaml | 17 - docs/dbinstancebackup/backup.yaml | 23 - docs/dbinstancebackup/backups.yaml | 32 - docs/dbinstancedatabase/database.yaml | 23 - docs/dbinstancedatabase/databases.yaml | 30 - docs/disk/create-snapshot.yaml | 16 - docs/disk/disk.yaml | 39 - docs/disk/disks.yaml | 37 - docs/disk/private.yaml | 11 - docs/disk/public.yaml | 12 - docs/disk/purge.yaml | 12 - docs/disk/reset.yaml | 17 - docs/disk/resize.yaml | 16 - docs/disk/save.yaml | 16 - .../allocate-public-connection.yaml | 15 - docs/elasticcache/change-spec.yaml | 15 - docs/elasticcache/elasticcache.yaml | 23 - docs/elasticcache/elasticcacheaccount.yaml | 23 - docs/elasticcache/elasticcacheaccounts.yaml | 30 - docs/elasticcache/elasticcacheacl.yaml | 40 - docs/elasticcache/elasticcacheacls.yaml | 30 - docs/elasticcache/elasticcachebackup.yaml | 23 - docs/elasticcache/elasticcachebackups.yaml | 25 - docs/elasticcache/elasticcacheparameter.yaml | 40 - docs/elasticcache/elasticcacheparameters.yaml | 14 - docs/elasticcache/elasticcaches.yaml | 36 - docs/elasticcache/elasticcacheskus.yaml | 19 - docs/elasticcache/flush-instance.yaml | 9 - docs/elasticcache/login-info.yaml | 9 - .../release-public-connection.yaml | 9 - docs/elasticcache/reset-password.yaml | 15 - docs/elasticcache/restart.yaml | 9 - docs/elasticcache/restore-instance.yaml | 9 - docs/elasticcache/set-maintain-time.yaml | 15 - docs/elasticcache/update-auth-mode.yaml | 15 - docs/elasticcache/update-backup-policy.yaml | 15 - .../update-instance-parameters.yaml | 0 docs/elasticip/associate.yaml | 14 - docs/elasticip/change-bandwidth.yaml | 13 - docs/elasticip/dissociate.yaml | 13 - docs/elasticip/elasticip.yaml | 39 - docs/elasticip/elasticips.yaml | 38 - docs/elasticip/purge.yaml | 12 - docs/elasticip/sync.yaml | 12 - docs/host/add-netif.yaml | 16 - docs/host/convert-hypervisor.yaml | 16 - docs/host/disable.yaml | 11 - docs/host/enable.yaml | 11 - docs/host/host.yaml | 40 - docs/host/hosts.yaml | 44 - docs/host/ipmi.yaml | 11 - docs/host/maintenance.yaml | 11 - docs/host/ping.yaml | 11 - docs/host/prepare.yaml | 11 - docs/host/remove-netif.yaml | 16 - docs/host/renew-prepaid-recycle.yaml | 11 - docs/host/reset.yaml | 11 - docs/host/spec.yaml | 11 - docs/host/start.yaml | 11 - docs/host/stop.yaml | 11 - docs/host/syncstatus.yaml | 11 - docs/host/undo-convert.yaml | 11 - docs/host/undo-prepaid-recycle.yaml | 11 - docs/host/unmaintenance.yaml | 11 - docs/hoststorage/hoststorage.yaml | 29 - docs/hoststorage/hoststorages.yaml | 17 - docs/identity/auth_v2.yaml | 16 - docs/identity/auth_v3.yaml | 37 - docs/identity/credentials.yaml | 12 - docs/identity/domain.yaml | 40 - docs/identity/domains.yaml | 29 - docs/identity/endpoint.yaml | 40 - docs/identity/endpoints.yaml | 28 - docs/identity/group.yaml | 40 - docs/identity/group_join.yaml | 16 - docs/identity/group_leave.yaml | 16 - docs/identity/groups.yaml | 31 - docs/identity/groupuser.yaml | 21 - docs/identity/identity_provider.yaml | 40 - docs/identity/identity_providers.yaml | 29 - docs/identity/policies.yaml | 31 - docs/identity/policy.yaml | 40 - docs/identity/project.yaml | 40 - docs/identity/project_join.yaml | 16 - docs/identity/project_leave.yaml | 16 - docs/identity/projectgrouprole.yaml | 25 - docs/identity/projects.yaml | 31 - docs/identity/projectuserrole.yaml | 25 - docs/identity/region.yaml | 40 - docs/identity/regions.yaml | 28 - docs/identity/role.yaml | 40 - docs/identity/roleassignments.yaml | 19 - docs/identity/roles.yaml | 30 - docs/identity/service.yaml | 40 - docs/identity/services.yaml | 29 - docs/identity/user.yaml | 40 - docs/identity/user_join.yaml | 16 - docs/identity/user_leave.yaml | 16 - docs/identity/users.yaml | 32 - docs/identity/verify_v2.yaml | 11 - docs/image/guest-image.yaml | 22 - docs/image/guest-images.yaml | 13 - docs/image/image-standard.yaml | 16 - docs/image/image.yaml | 220 - docs/image/images.yaml | 35 - docs/index.yaml | 669 - docs/instance/add-secgroup.yaml | 16 - docs/instance/assign-secgroup.yaml | 16 - docs/instance/associate-eip.yaml | 16 - docs/instance/attach-isolate-device.yaml | 16 - docs/instance/attachdisk.yaml | 16 - docs/instance/attachnetwork.yaml | 16 - docs/instance/bind-groups.yaml | 16 - docs/instance/cancel-delete.yaml | 11 - docs/instance/change-bandwidth.yaml | 16 - docs/instance/change-config.yaml | 16 - docs/instance/change-ip-addr.yaml | 16 - docs/instance/create-backup.yaml | 11 - docs/instance/create-eip.yaml | 16 - docs/instance/createdisk.yaml | 16 - docs/instance/del-extra-option.yaml | 16 - docs/instance/delete-backup.yaml | 16 - docs/instance/deploy.yaml | 16 - docs/instance/detach-isolate-device.yaml | 16 - docs/instance/detachdisk.yaml | 16 - docs/instance/detachnetwork.yaml | 16 - docs/instance/dissociate-eip.yaml | 16 - docs/instance/ejectiso.yaml | 11 - docs/instance/insertiso.yaml | 16 - docs/instance/instance.yaml | 40 - docs/instance/instances.yaml | 49 - docs/instance/io-throttle.yaml | 16 - docs/instance/live-migrate.yaml | 16 - docs/instance/migrate.yaml | 16 - docs/instance/monitor.yaml | 16 - docs/instance/purge.yaml | 11 - docs/instance/rebuild-root.yaml | 16 - docs/instance/renew.yaml | 16 - docs/instance/reset.yaml | 16 - docs/instance/restart.yaml | 16 - docs/instance/revoke-secgroup.yaml | 16 - docs/instance/save-guest-image.yaml | 16 - docs/instance/save-image.yaml | 16 - docs/instance/send-keys.yaml | 16 - docs/instance/set-extra-option.yaml | 16 - docs/instance/set-secgroup.yaml | 16 - docs/instance/start.yaml | 11 - docs/instance/status.yaml | 16 - docs/instance/stop.yaml | 16 - docs/instance/suspend.yaml | 11 - docs/instance/switch-to-backup.yaml | 11 - docs/instance/sync.yaml | 11 - docs/instance/syncstatus.yaml | 11 - docs/instance/unbind-groups.yaml | 16 - docs/instance/user-data.yaml | 16 - docs/instance/vnc.yaml | 11 - docs/instancegroup/bind-guest.yaml | 16 - docs/instancegroup/instancegroup.yaml | 22 - docs/instancegroup/instancegroups.yaml | 31 - docs/instancegroup/unbind-guest.yaml | 16 - docs/keypair/keypair.yaml | 39 - docs/keypair/keypairs.yaml | 29 - docs/loadbalancer/loadbalancer.yaml | 22 - .../loadbalanceragent-deploy.yaml | 32 - .../loadbalanceragent-params-patch.yaml | 15 - .../loadbalanceragent-undeploy.yaml | 18 - docs/loadbalancer/loadbalanceragent.yaml | 46 - docs/loadbalancer/loadbalanceragents.yaml | 25 - docs/loadbalancer/loadbalancerbackend.yaml | 22 - .../loadbalancerbackendgroup.yaml | 22 - .../loadbalancerbackendgroups.yaml | 26 - docs/loadbalancer/loadbalancerbackends.yaml | 27 - docs/loadbalancer/loadbalancercachedacl.yaml | 21 - docs/loadbalancer/loadbalancercachedacls.yaml | 25 - .../loadbalancercachedcertificate.yaml | 21 - .../loadbalancercachedcertificates.yaml | 25 - docs/loadbalancer/loadbalancercluster.yaml | 26 - docs/loadbalancer/loadbalancerclusters.yaml | 23 - .../loadbalancerlistener-backend-status.yaml | 11 - docs/loadbalancer/loadbalancerlistener.yaml | 22 - ...adbalancerlistenerrule-backend-status.yaml | 11 - .../loadbalancerlistenerrule.yaml | 22 - .../loadbalancerlistenerrules.yaml | 29 - docs/loadbalancer/loadbalancerlisteners.yaml | 28 - docs/loadbalancer/loadbalancers.yaml | 20 - docs/natgateway/dnat-resources.yaml | 13 - docs/natgateway/dnatentries.yaml | 32 - docs/natgateway/dnatentry.yaml | 22 - docs/natgateway/natgateway.yaml | 11 - docs/natgateway/natgateways.yaml | 18 - docs/natgateway/snat-resources.yaml | 11 - docs/natgateway/snatentries.yaml | 33 - docs/natgateway/snatentry.yaml | 22 - docs/network/network.yaml | 137 - docs/network/networkinterface.yaml | 11 - docs/network/networks.yaml | 38 - docs/networkinterface/networkinterface.yaml | 23 - docs/networkinterface/networkinterfaces.yaml | 14 - docs/networkinterface/networks.yaml | 11 - .../networkinterfacenetworks.yaml | 12 - docs/parameters/ansibleplaybook.yaml | 5 - docs/parameters/auth.yaml | 14 - docs/parameters/bucket.yaml | 48 - docs/parameters/cloudaccount.yaml | 25 - docs/parameters/common.yaml | 143 - docs/parameters/credential.yaml | 13 - docs/parameters/dbinstance.yaml | 49 - docs/parameters/dbinstance_sku.yaml | 6 - docs/parameters/disk.yaml | 57 - docs/parameters/domain.yaml | 6 - docs/parameters/elasticcache.yaml | 52 - docs/parameters/elasticip.yaml | 63 - docs/parameters/endpoint.yaml | 6 - docs/parameters/group.yaml | 6 - docs/parameters/host.yaml | 80 - docs/parameters/hoststorage.yaml | 12 - docs/parameters/identity.yaml | 29 - docs/parameters/identity_provider.yaml | 6 - docs/parameters/image.yaml | 71 - docs/parameters/instance.yaml | 72 - docs/parameters/instancegroup.yaml | 13 - docs/parameters/keypair.yaml | 13 - docs/parameters/loadbalancer.yaml | 118 - docs/parameters/natgateway.yaml | 29 - docs/parameters/network.yaml | 36 - docs/parameters/networkinterface.yaml | 6 - docs/parameters/policy.yaml | 6 - docs/parameters/project.yaml | 6 - docs/parameters/quota.yaml | 58 - docs/parameters/region.yaml | 6 - docs/parameters/role.yaml | 6 - docs/parameters/roleassignments.yaml | 53 - docs/parameters/secgroup.yaml | 30 - docs/parameters/secgroupcache.yaml | 13 - docs/parameters/secgrouprule.yaml | 12 - docs/parameters/serversku.yaml | 27 - docs/parameters/service.yaml | 6 - docs/parameters/snapshotpolicy.yaml | 28 - docs/parameters/storage.yaml | 24 - docs/parameters/storagecache.yaml | 22 - docs/parameters/user.yaml | 12 - docs/quotas/domainquotas.yaml | 22 - docs/quotas/projectquotalist.yaml | 11 - docs/quotas/projectquotas.yaml | 22 - docs/quotas/quotalist.yaml | 9 - docs/quotas/quotas.yaml | 11 - docs/schemas/ansibleplaybook.yaml | 126 - docs/schemas/auth.yaml | 344 - docs/schemas/bucket.yaml | 235 - docs/schemas/cloudaccount.yaml | 292 - docs/schemas/common.yaml | 212 - docs/schemas/credential.yaml | 50 - docs/schemas/dbinstance.yaml | 250 - docs/schemas/dbinstance_account.yaml | 134 - docs/schemas/dbinstance_backup.yaml | 100 - docs/schemas/dbinstance_database.yaml | 103 - docs/schemas/dbinstance_network.yaml | 42 - docs/schemas/dbinstance_parameter.yaml | 44 - docs/schemas/dbinstance_sku.yaml | 105 - docs/schemas/disk.yaml | 257 - docs/schemas/domain.yaml | 71 - docs/schemas/elasticcache.yaml | 626 - docs/schemas/elasticip.yaml | 126 - docs/schemas/endpoint.yaml | 111 - docs/schemas/group.yaml | 71 - docs/schemas/guest_image.yaml | 107 - docs/schemas/host.yaml | 486 - docs/schemas/hoststorage.yaml | 78 - docs/schemas/identity_provider.yaml | 69 - docs/schemas/image.yaml | 132 - docs/schemas/instance.yaml | 1142 - docs/schemas/instancegroup.yaml | 149 - docs/schemas/keypair.yaml | 90 - docs/schemas/loadbalancer.yaml | 762 - docs/schemas/natgateway.yaml | 380 - docs/schemas/network.yaml | 287 - docs/schemas/networkinterface.yaml | 44 - docs/schemas/networkinterfacenetwork.yaml | 45 - docs/schemas/policy.yaml | 89 - docs/schemas/project.yaml | 140 - docs/schemas/quota.yaml | 133 - docs/schemas/region.yaml | 67 - docs/schemas/role.yaml | 62 - docs/schemas/roleassignments.yaml | 99 - docs/schemas/secgroup.yaml | 181 - docs/schemas/secgroupcache.yaml | 67 - docs/schemas/secgrouprule.yaml | 132 - docs/schemas/serversku.yaml | 155 - docs/schemas/service.yaml | 84 - docs/schemas/snapshotpolicy.yaml | 206 - docs/schemas/storage.yaml | 245 - docs/schemas/storagecache.yaml | 56 - docs/schemas/user.yaml | 74 - docs/secgroup/add-rule.yaml | 16 - docs/secgroup/cache-secgroup.yaml | 16 - docs/secgroup/clone.yaml | 16 - docs/secgroup/private.yaml | 12 - docs/secgroup/public.yaml | 14 - docs/secgroup/secgroup.yaml | 39 - docs/secgroup/secgroups.yaml | 28 - docs/secgroup/uncache-secgroup.yaml | 16 - docs/secgroup/union.yaml | 16 - docs/secgroupcache/secgroupcache.yaml | 22 - docs/secgroupcache/secgroupcaches.yaml | 13 - docs/secgrouprule/secgrouprule.yaml | 39 - docs/secgrouprule/secgrouprules.yaml | 29 - docs/server.py | 14 - docs/serversku/cache-sku.yaml | 12 - docs/serversku/disable.yaml | 12 - docs/serversku/enable.yaml | 12 - docs/serversku/serversku.yaml | 23 - docs/serversku/serverskus.yaml | 35 - docs/snapshotpolicy/bind-disk.yaml | 16 - docs/snapshotpolicy/cache.yaml | 17 - docs/snapshotpolicy/snapshotpolicies.yaml | 32 - docs/snapshotpolicy/snapshotpolicy.yaml | 22 - docs/snapshotpolicy/snapshotpolicydisk.yaml | 11 - docs/snapshotpolicy/snapshotpolicydisk2.yaml | 11 - docs/snapshotpolicy/snapshotpolicydisk3.yaml | 23 - docs/snapshotpolicy/unbind-disk.yaml | 16 - docs/storage/storage.yaml | 91 - docs/storage/storages.yaml | 34 - docs/storagecache/cache-image.yaml | 14 - docs/storagecache/storagecache.yaml | 11 - docs/storagecache/storagecaches.yaml | 19 - docs/swagger/index.html | 150 + docs/swagger/swagger_cloudevent.yaml | 1491 + docs/swagger/swagger_cloudid.yaml | 8809 + docs/swagger/swagger_compute.yaml | 165449 +++++++++++++++ docs/swagger/swagger_identity.yaml | 12691 ++ docs/swagger/swagger_image.yaml | 3365 + docs/swagger/swagger_monitor.yaml | 18172 ++ docs/swagger/swagger_notify.yaml | 8911 + docs/swagger/swagger_yunionconf.yaml | 1848 + pkg/apis/compute/zz_generated.model.go | 68 +- pkg/apis/identity/zz_generated.model.go | 4 +- pkg/apis/notify/zz_generated.model.go | 57 +- pkg/apis/zz_generated.model.go | 2 +- 390 files changed, 220981 insertions(+), 17076 deletions(-) delete mode 100644 docs/README.md delete mode 100644 docs/ansibleplaybook/ansibleplaybook-run.yaml delete mode 100644 docs/ansibleplaybook/ansibleplaybook-stop.yaml delete mode 100644 docs/ansibleplaybook/ansibleplaybook.yaml delete mode 100644 docs/ansibleplaybook/ansibleplaybooks.yaml delete mode 100644 docs/bucket/access.yaml delete mode 100644 docs/bucket/acl.yaml delete mode 100644 docs/bucket/bucket.yaml delete mode 100644 docs/bucket/buckets.yaml delete mode 100644 docs/bucket/deleteobjects.yaml delete mode 100644 docs/bucket/limit.yaml delete mode 100644 docs/bucket/listobjects.yaml delete mode 100644 docs/bucket/makedir.yaml delete mode 100644 docs/bucket/tempurl.yaml delete mode 100644 docs/bucket/uploadobject.yaml delete mode 100644 docs/build/build-host-image.md delete mode 100644 docs/cloudaccount/change-project.yaml delete mode 100644 docs/cloudaccount/cloudaccount.yaml delete mode 100644 docs/cloudaccount/cloudaccounts.yaml delete mode 100644 docs/cloudaccount/disable-auto-sync.yaml delete mode 100644 docs/cloudaccount/disable.yaml delete mode 100644 docs/cloudaccount/enable-auto-sync.yaml delete mode 100644 docs/cloudaccount/enable.yaml delete mode 100644 docs/cloudaccount/private.yaml delete mode 100644 docs/cloudaccount/public.yaml delete mode 100644 docs/cloudaccount/sync.yaml delete mode 100644 docs/cloudaccount/update-credential.yaml delete mode 100644 docs/dbinstance/change-config.yaml delete mode 100644 docs/dbinstance/dbinstance.yaml delete mode 100644 docs/dbinstance/dbinstanceaccount.yaml delete mode 100644 docs/dbinstance/dbinstanceaccounts.yaml delete mode 100644 docs/dbinstance/dbinstancebackup.yaml delete mode 100644 docs/dbinstance/dbinstancebackups.yaml delete mode 100644 docs/dbinstance/dbinstancedatabase.yaml delete mode 100644 docs/dbinstance/dbinstancedatabases.yaml delete mode 100644 docs/dbinstance/dbinstancenetwork.yaml delete mode 100644 docs/dbinstance/dbinstancenetworks.yaml delete mode 100644 docs/dbinstance/dbinstanceparameter.yaml delete mode 100644 docs/dbinstance/dbinstanceparameters.yaml delete mode 100644 docs/dbinstance/dbinstances.yaml delete mode 100644 docs/dbinstance/public-connection.yaml delete mode 100644 docs/dbinstance/purge.yaml delete mode 100644 docs/dbinstance/reboot.yaml delete mode 100644 docs/dbinstance/recovery.yaml delete mode 100644 docs/dbinstance/sync-status.yaml delete mode 100644 docs/dbinstance_sku/dbinstance_sku.yaml delete mode 100644 docs/dbinstance_sku/dbinstance_skus.yaml delete mode 100644 docs/dbinstanceaccount/account.yaml delete mode 100644 docs/dbinstanceaccount/accounts.yaml delete mode 100644 docs/dbinstanceaccount/grant-privilege.yaml delete mode 100644 docs/dbinstanceaccount/reset-password.yaml delete mode 100644 docs/dbinstanceaccount/revoke-privilege.yaml delete mode 100644 docs/dbinstanceaccount/set-privileges.yaml delete mode 100644 docs/dbinstancebackup/backup.yaml delete mode 100644 docs/dbinstancebackup/backups.yaml delete mode 100644 docs/dbinstancedatabase/database.yaml delete mode 100644 docs/dbinstancedatabase/databases.yaml delete mode 100644 docs/disk/create-snapshot.yaml delete mode 100644 docs/disk/disk.yaml delete mode 100644 docs/disk/disks.yaml delete mode 100644 docs/disk/private.yaml delete mode 100644 docs/disk/public.yaml delete mode 100644 docs/disk/purge.yaml delete mode 100644 docs/disk/reset.yaml delete mode 100644 docs/disk/resize.yaml delete mode 100644 docs/disk/save.yaml delete mode 100644 docs/elasticcache/allocate-public-connection.yaml delete mode 100644 docs/elasticcache/change-spec.yaml delete mode 100644 docs/elasticcache/elasticcache.yaml delete mode 100644 docs/elasticcache/elasticcacheaccount.yaml delete mode 100644 docs/elasticcache/elasticcacheaccounts.yaml delete mode 100644 docs/elasticcache/elasticcacheacl.yaml delete mode 100644 docs/elasticcache/elasticcacheacls.yaml delete mode 100644 docs/elasticcache/elasticcachebackup.yaml delete mode 100644 docs/elasticcache/elasticcachebackups.yaml delete mode 100644 docs/elasticcache/elasticcacheparameter.yaml delete mode 100644 docs/elasticcache/elasticcacheparameters.yaml delete mode 100644 docs/elasticcache/elasticcaches.yaml delete mode 100644 docs/elasticcache/elasticcacheskus.yaml delete mode 100644 docs/elasticcache/flush-instance.yaml delete mode 100644 docs/elasticcache/login-info.yaml delete mode 100644 docs/elasticcache/release-public-connection.yaml delete mode 100644 docs/elasticcache/reset-password.yaml delete mode 100644 docs/elasticcache/restart.yaml delete mode 100644 docs/elasticcache/restore-instance.yaml delete mode 100644 docs/elasticcache/set-maintain-time.yaml delete mode 100644 docs/elasticcache/update-auth-mode.yaml delete mode 100644 docs/elasticcache/update-backup-policy.yaml delete mode 100644 docs/elasticcache/update-instance-parameters.yaml delete mode 100644 docs/elasticip/associate.yaml delete mode 100644 docs/elasticip/change-bandwidth.yaml delete mode 100644 docs/elasticip/dissociate.yaml delete mode 100644 docs/elasticip/elasticip.yaml delete mode 100644 docs/elasticip/elasticips.yaml delete mode 100644 docs/elasticip/purge.yaml delete mode 100644 docs/elasticip/sync.yaml delete mode 100644 docs/host/add-netif.yaml delete mode 100644 docs/host/convert-hypervisor.yaml delete mode 100644 docs/host/disable.yaml delete mode 100644 docs/host/enable.yaml delete mode 100644 docs/host/host.yaml delete mode 100644 docs/host/hosts.yaml delete mode 100644 docs/host/ipmi.yaml delete mode 100644 docs/host/maintenance.yaml delete mode 100644 docs/host/ping.yaml delete mode 100644 docs/host/prepare.yaml delete mode 100644 docs/host/remove-netif.yaml delete mode 100644 docs/host/renew-prepaid-recycle.yaml delete mode 100644 docs/host/reset.yaml delete mode 100644 docs/host/spec.yaml delete mode 100644 docs/host/start.yaml delete mode 100644 docs/host/stop.yaml delete mode 100644 docs/host/syncstatus.yaml delete mode 100644 docs/host/undo-convert.yaml delete mode 100644 docs/host/undo-prepaid-recycle.yaml delete mode 100644 docs/host/unmaintenance.yaml delete mode 100644 docs/hoststorage/hoststorage.yaml delete mode 100644 docs/hoststorage/hoststorages.yaml delete mode 100644 docs/identity/auth_v2.yaml delete mode 100644 docs/identity/auth_v3.yaml delete mode 100644 docs/identity/credentials.yaml delete mode 100644 docs/identity/domain.yaml delete mode 100644 docs/identity/domains.yaml delete mode 100644 docs/identity/endpoint.yaml delete mode 100644 docs/identity/endpoints.yaml delete mode 100644 docs/identity/group.yaml delete mode 100644 docs/identity/group_join.yaml delete mode 100644 docs/identity/group_leave.yaml delete mode 100644 docs/identity/groups.yaml delete mode 100644 docs/identity/groupuser.yaml delete mode 100644 docs/identity/identity_provider.yaml delete mode 100644 docs/identity/identity_providers.yaml delete mode 100644 docs/identity/policies.yaml delete mode 100644 docs/identity/policy.yaml delete mode 100644 docs/identity/project.yaml delete mode 100644 docs/identity/project_join.yaml delete mode 100644 docs/identity/project_leave.yaml delete mode 100644 docs/identity/projectgrouprole.yaml delete mode 100644 docs/identity/projects.yaml delete mode 100644 docs/identity/projectuserrole.yaml delete mode 100644 docs/identity/region.yaml delete mode 100644 docs/identity/regions.yaml delete mode 100644 docs/identity/role.yaml delete mode 100644 docs/identity/roleassignments.yaml delete mode 100644 docs/identity/roles.yaml delete mode 100644 docs/identity/service.yaml delete mode 100644 docs/identity/services.yaml delete mode 100644 docs/identity/user.yaml delete mode 100644 docs/identity/user_join.yaml delete mode 100644 docs/identity/user_leave.yaml delete mode 100644 docs/identity/users.yaml delete mode 100644 docs/identity/verify_v2.yaml delete mode 100644 docs/image/guest-image.yaml delete mode 100644 docs/image/guest-images.yaml delete mode 100644 docs/image/image-standard.yaml delete mode 100644 docs/image/image.yaml delete mode 100644 docs/image/images.yaml delete mode 100644 docs/index.yaml delete mode 100644 docs/instance/add-secgroup.yaml delete mode 100644 docs/instance/assign-secgroup.yaml delete mode 100644 docs/instance/associate-eip.yaml delete mode 100644 docs/instance/attach-isolate-device.yaml delete mode 100644 docs/instance/attachdisk.yaml delete mode 100644 docs/instance/attachnetwork.yaml delete mode 100644 docs/instance/bind-groups.yaml delete mode 100644 docs/instance/cancel-delete.yaml delete mode 100644 docs/instance/change-bandwidth.yaml delete mode 100644 docs/instance/change-config.yaml delete mode 100644 docs/instance/change-ip-addr.yaml delete mode 100644 docs/instance/create-backup.yaml delete mode 100644 docs/instance/create-eip.yaml delete mode 100644 docs/instance/createdisk.yaml delete mode 100644 docs/instance/del-extra-option.yaml delete mode 100644 docs/instance/delete-backup.yaml delete mode 100644 docs/instance/deploy.yaml delete mode 100644 docs/instance/detach-isolate-device.yaml delete mode 100644 docs/instance/detachdisk.yaml delete mode 100644 docs/instance/detachnetwork.yaml delete mode 100644 docs/instance/dissociate-eip.yaml delete mode 100644 docs/instance/ejectiso.yaml delete mode 100644 docs/instance/insertiso.yaml delete mode 100644 docs/instance/instance.yaml delete mode 100644 docs/instance/instances.yaml delete mode 100644 docs/instance/io-throttle.yaml delete mode 100644 docs/instance/live-migrate.yaml delete mode 100644 docs/instance/migrate.yaml delete mode 100644 docs/instance/monitor.yaml delete mode 100644 docs/instance/purge.yaml delete mode 100644 docs/instance/rebuild-root.yaml delete mode 100644 docs/instance/renew.yaml delete mode 100644 docs/instance/reset.yaml delete mode 100644 docs/instance/restart.yaml delete mode 100644 docs/instance/revoke-secgroup.yaml delete mode 100644 docs/instance/save-guest-image.yaml delete mode 100644 docs/instance/save-image.yaml delete mode 100644 docs/instance/send-keys.yaml delete mode 100644 docs/instance/set-extra-option.yaml delete mode 100644 docs/instance/set-secgroup.yaml delete mode 100644 docs/instance/start.yaml delete mode 100644 docs/instance/status.yaml delete mode 100644 docs/instance/stop.yaml delete mode 100644 docs/instance/suspend.yaml delete mode 100644 docs/instance/switch-to-backup.yaml delete mode 100644 docs/instance/sync.yaml delete mode 100644 docs/instance/syncstatus.yaml delete mode 100644 docs/instance/unbind-groups.yaml delete mode 100644 docs/instance/user-data.yaml delete mode 100644 docs/instance/vnc.yaml delete mode 100644 docs/instancegroup/bind-guest.yaml delete mode 100644 docs/instancegroup/instancegroup.yaml delete mode 100644 docs/instancegroup/instancegroups.yaml delete mode 100644 docs/instancegroup/unbind-guest.yaml delete mode 100644 docs/keypair/keypair.yaml delete mode 100644 docs/keypair/keypairs.yaml delete mode 100644 docs/loadbalancer/loadbalancer.yaml delete mode 100644 docs/loadbalancer/loadbalanceragent-deploy.yaml delete mode 100644 docs/loadbalancer/loadbalanceragent-params-patch.yaml delete mode 100644 docs/loadbalancer/loadbalanceragent-undeploy.yaml delete mode 100644 docs/loadbalancer/loadbalanceragent.yaml delete mode 100644 docs/loadbalancer/loadbalanceragents.yaml delete mode 100644 docs/loadbalancer/loadbalancerbackend.yaml delete mode 100644 docs/loadbalancer/loadbalancerbackendgroup.yaml delete mode 100644 docs/loadbalancer/loadbalancerbackendgroups.yaml delete mode 100644 docs/loadbalancer/loadbalancerbackends.yaml delete mode 100644 docs/loadbalancer/loadbalancercachedacl.yaml delete mode 100644 docs/loadbalancer/loadbalancercachedacls.yaml delete mode 100644 docs/loadbalancer/loadbalancercachedcertificate.yaml delete mode 100644 docs/loadbalancer/loadbalancercachedcertificates.yaml delete mode 100644 docs/loadbalancer/loadbalancercluster.yaml delete mode 100644 docs/loadbalancer/loadbalancerclusters.yaml delete mode 100644 docs/loadbalancer/loadbalancerlistener-backend-status.yaml delete mode 100644 docs/loadbalancer/loadbalancerlistener.yaml delete mode 100644 docs/loadbalancer/loadbalancerlistenerrule-backend-status.yaml delete mode 100644 docs/loadbalancer/loadbalancerlistenerrule.yaml delete mode 100644 docs/loadbalancer/loadbalancerlistenerrules.yaml delete mode 100644 docs/loadbalancer/loadbalancerlisteners.yaml delete mode 100644 docs/loadbalancer/loadbalancers.yaml delete mode 100644 docs/natgateway/dnat-resources.yaml delete mode 100644 docs/natgateway/dnatentries.yaml delete mode 100644 docs/natgateway/dnatentry.yaml delete mode 100644 docs/natgateway/natgateway.yaml delete mode 100644 docs/natgateway/natgateways.yaml delete mode 100644 docs/natgateway/snat-resources.yaml delete mode 100644 docs/natgateway/snatentries.yaml delete mode 100644 docs/natgateway/snatentry.yaml delete mode 100644 docs/network/network.yaml delete mode 100644 docs/network/networkinterface.yaml delete mode 100644 docs/network/networks.yaml delete mode 100644 docs/networkinterface/networkinterface.yaml delete mode 100644 docs/networkinterface/networkinterfaces.yaml delete mode 100644 docs/networkinterface/networks.yaml delete mode 100644 docs/networkinterfacenetwork/networkinterfacenetworks.yaml delete mode 100644 docs/parameters/ansibleplaybook.yaml delete mode 100644 docs/parameters/auth.yaml delete mode 100644 docs/parameters/bucket.yaml delete mode 100644 docs/parameters/cloudaccount.yaml delete mode 100644 docs/parameters/common.yaml delete mode 100644 docs/parameters/credential.yaml delete mode 100644 docs/parameters/dbinstance.yaml delete mode 100644 docs/parameters/dbinstance_sku.yaml delete mode 100644 docs/parameters/disk.yaml delete mode 100644 docs/parameters/domain.yaml delete mode 100644 docs/parameters/elasticcache.yaml delete mode 100644 docs/parameters/elasticip.yaml delete mode 100644 docs/parameters/endpoint.yaml delete mode 100644 docs/parameters/group.yaml delete mode 100644 docs/parameters/host.yaml delete mode 100644 docs/parameters/hoststorage.yaml delete mode 100644 docs/parameters/identity.yaml delete mode 100644 docs/parameters/identity_provider.yaml delete mode 100644 docs/parameters/image.yaml delete mode 100644 docs/parameters/instance.yaml delete mode 100644 docs/parameters/instancegroup.yaml delete mode 100644 docs/parameters/keypair.yaml delete mode 100644 docs/parameters/loadbalancer.yaml delete mode 100644 docs/parameters/natgateway.yaml delete mode 100644 docs/parameters/network.yaml delete mode 100644 docs/parameters/networkinterface.yaml delete mode 100644 docs/parameters/policy.yaml delete mode 100644 docs/parameters/project.yaml delete mode 100644 docs/parameters/quota.yaml delete mode 100644 docs/parameters/region.yaml delete mode 100644 docs/parameters/role.yaml delete mode 100644 docs/parameters/roleassignments.yaml delete mode 100644 docs/parameters/secgroup.yaml delete mode 100644 docs/parameters/secgroupcache.yaml delete mode 100644 docs/parameters/secgrouprule.yaml delete mode 100644 docs/parameters/serversku.yaml delete mode 100644 docs/parameters/service.yaml delete mode 100644 docs/parameters/snapshotpolicy.yaml delete mode 100644 docs/parameters/storage.yaml delete mode 100644 docs/parameters/storagecache.yaml delete mode 100644 docs/parameters/user.yaml delete mode 100644 docs/quotas/domainquotas.yaml delete mode 100644 docs/quotas/projectquotalist.yaml delete mode 100644 docs/quotas/projectquotas.yaml delete mode 100644 docs/quotas/quotalist.yaml delete mode 100644 docs/quotas/quotas.yaml delete mode 100644 docs/schemas/ansibleplaybook.yaml delete mode 100644 docs/schemas/auth.yaml delete mode 100644 docs/schemas/bucket.yaml delete mode 100644 docs/schemas/cloudaccount.yaml delete mode 100644 docs/schemas/common.yaml delete mode 100644 docs/schemas/credential.yaml delete mode 100644 docs/schemas/dbinstance.yaml delete mode 100644 docs/schemas/dbinstance_account.yaml delete mode 100644 docs/schemas/dbinstance_backup.yaml delete mode 100644 docs/schemas/dbinstance_database.yaml delete mode 100644 docs/schemas/dbinstance_network.yaml delete mode 100644 docs/schemas/dbinstance_parameter.yaml delete mode 100644 docs/schemas/dbinstance_sku.yaml delete mode 100644 docs/schemas/disk.yaml delete mode 100644 docs/schemas/domain.yaml delete mode 100644 docs/schemas/elasticcache.yaml delete mode 100644 docs/schemas/elasticip.yaml delete mode 100644 docs/schemas/endpoint.yaml delete mode 100644 docs/schemas/group.yaml delete mode 100644 docs/schemas/guest_image.yaml delete mode 100644 docs/schemas/host.yaml delete mode 100644 docs/schemas/hoststorage.yaml delete mode 100644 docs/schemas/identity_provider.yaml delete mode 100644 docs/schemas/image.yaml delete mode 100644 docs/schemas/instance.yaml delete mode 100644 docs/schemas/instancegroup.yaml delete mode 100644 docs/schemas/keypair.yaml delete mode 100644 docs/schemas/loadbalancer.yaml delete mode 100644 docs/schemas/natgateway.yaml delete mode 100644 docs/schemas/network.yaml delete mode 100644 docs/schemas/networkinterface.yaml delete mode 100644 docs/schemas/networkinterfacenetwork.yaml delete mode 100644 docs/schemas/policy.yaml delete mode 100644 docs/schemas/project.yaml delete mode 100644 docs/schemas/quota.yaml delete mode 100644 docs/schemas/region.yaml delete mode 100644 docs/schemas/role.yaml delete mode 100644 docs/schemas/roleassignments.yaml delete mode 100644 docs/schemas/secgroup.yaml delete mode 100644 docs/schemas/secgroupcache.yaml delete mode 100644 docs/schemas/secgrouprule.yaml delete mode 100644 docs/schemas/serversku.yaml delete mode 100644 docs/schemas/service.yaml delete mode 100644 docs/schemas/snapshotpolicy.yaml delete mode 100644 docs/schemas/storage.yaml delete mode 100644 docs/schemas/storagecache.yaml delete mode 100644 docs/schemas/user.yaml delete mode 100644 docs/secgroup/add-rule.yaml delete mode 100644 docs/secgroup/cache-secgroup.yaml delete mode 100644 docs/secgroup/clone.yaml delete mode 100644 docs/secgroup/private.yaml delete mode 100644 docs/secgroup/public.yaml delete mode 100644 docs/secgroup/secgroup.yaml delete mode 100644 docs/secgroup/secgroups.yaml delete mode 100644 docs/secgroup/uncache-secgroup.yaml delete mode 100644 docs/secgroup/union.yaml delete mode 100644 docs/secgroupcache/secgroupcache.yaml delete mode 100644 docs/secgroupcache/secgroupcaches.yaml delete mode 100644 docs/secgrouprule/secgrouprule.yaml delete mode 100644 docs/secgrouprule/secgrouprules.yaml delete mode 100644 docs/server.py delete mode 100644 docs/serversku/cache-sku.yaml delete mode 100644 docs/serversku/disable.yaml delete mode 100644 docs/serversku/enable.yaml delete mode 100644 docs/serversku/serversku.yaml delete mode 100644 docs/serversku/serverskus.yaml delete mode 100644 docs/snapshotpolicy/bind-disk.yaml delete mode 100644 docs/snapshotpolicy/cache.yaml delete mode 100644 docs/snapshotpolicy/snapshotpolicies.yaml delete mode 100644 docs/snapshotpolicy/snapshotpolicy.yaml delete mode 100644 docs/snapshotpolicy/snapshotpolicydisk.yaml delete mode 100644 docs/snapshotpolicy/snapshotpolicydisk2.yaml delete mode 100644 docs/snapshotpolicy/snapshotpolicydisk3.yaml delete mode 100644 docs/snapshotpolicy/unbind-disk.yaml delete mode 100644 docs/storage/storage.yaml delete mode 100644 docs/storage/storages.yaml delete mode 100644 docs/storagecache/cache-image.yaml delete mode 100644 docs/storagecache/storagecache.yaml delete mode 100644 docs/storagecache/storagecaches.yaml create mode 100644 docs/swagger/index.html create mode 100644 docs/swagger/swagger_cloudevent.yaml create mode 100644 docs/swagger/swagger_cloudid.yaml create mode 100644 docs/swagger/swagger_compute.yaml create mode 100644 docs/swagger/swagger_identity.yaml create mode 100644 docs/swagger/swagger_image.yaml create mode 100644 docs/swagger/swagger_monitor.yaml create mode 100644 docs/swagger/swagger_notify.yaml create mode 100644 docs/swagger/swagger_yunionconf.yaml diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 83882371f5..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# swagger.yaml - -使用swagger编辑器 - - docker run -d -p 8081:8080 swaggerapi/swagger-editor - -swagger文档，https://swagger.io/docs/specification/2-0/basic-structure/ - -编辑测试： - -1. 首先启动swagger-ui - - sudo docker pull swaggerapi/swagger-ui - sudo docker run -d -p 80:8080 swaggerapi/swagger-ui - -2. 用python启动本地的http server，这是允许CORS的SimpleHTTPServer，监听在8000端口 - - python server.py - -3. 用浏览器打开swagger-ui的URL：http://?url=http://:8000/index.yaml diff --git a/docs/ansibleplaybook/ansibleplaybook-run.yaml b/docs/ansibleplaybook/ansibleplaybook-run.yaml deleted file mode 100644 index 770ad18135..0000000000 --- a/docs/ansibleplaybook/ansibleplaybook-run.yaml +++ /dev/null @@ -1,21 +0,0 @@ -post: - summary: 执行ansibleplaybook - description: | - 调用成功后 - - - start_time将置为当前时间 - - end_time置为空 - - status设置为running - parameters: - - $ref: "../parameters/ansibleplaybook.yaml#/ansibleplaybookId" - - name: ansibleplaybook - in: body - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookCreateRequest" - responses: - 200: - description: ansibleplaybook的信息 - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookResponse" - tags: - - ansibleplaybooks diff --git a/docs/ansibleplaybook/ansibleplaybook-stop.yaml b/docs/ansibleplaybook/ansibleplaybook-stop.yaml deleted file mode 100644 index c1f6540bd9..0000000000 --- a/docs/ansibleplaybook/ansibleplaybook-stop.yaml +++ /dev/null @@ -1,20 +0,0 @@ -post: - summary: 中止执行ansibleplaybook - description: | - 调用成功后 - - - end_time置为当前时间 - - status设置为canceled - parameters: - - $ref: "../parameters/ansibleplaybook.yaml#/ansibleplaybookId" - - name: ansibleplaybook - in: body - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookCreateRequest" - responses: - 200: - description: ansibleplaybook的信息 - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookResponse" - tags: - - ansibleplaybooks diff --git a/docs/ansibleplaybook/ansibleplaybook.yaml b/docs/ansibleplaybook/ansibleplaybook.yaml deleted file mode 100644 index 421e81bb83..0000000000 --- a/docs/ansibleplaybook/ansibleplaybook.yaml +++ /dev/null @@ -1,41 +0,0 @@ -get: - summary: 获取指定ansibleplaybook的信息 - parameters: - - $ref: "../parameters/ansibleplaybook.yaml#/ansibleplaybookId" - responses: - 200: - description: ansibleplaybook信息 - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookResponse" - tags: - - ansibleplaybooks - -put: - summary: 更新ansibleplaybook自身参数 - parameters: - - $ref: "../parameters/ansibleplaybook.yaml#/ansibleplaybookId" - - name: ansibleplaybook - in: body - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookCreateRequest" - responses: - 200: - description: ansibleplaybook的信息 - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookResponse" - tags: - - ansibleplaybooks - -delete: - summary: 删除指定ansibleplaybook - description: | - 处于运行状态的playbook需先中止执行才允许删除 - parameters: - - $ref: "../parameters/ansibleplaybook.yaml#/ansibleplaybookId" - responses: - 200: - description: 被删除ansibleplaybook的信息 - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookResponse" - tags: - - ansibleplaybooks diff --git a/docs/ansibleplaybook/ansibleplaybooks.yaml b/docs/ansibleplaybook/ansibleplaybooks.yaml deleted file mode 100644 index 948c254416..0000000000 --- a/docs/ansibleplaybook/ansibleplaybooks.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 按指定条件列出ansibleplaybook实例 - responses: - 200: - description: 实例列表信息 - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookListResponse" - tags: - - ansibleplaybooks -post: - summary: 创建ansibleplaybook实例 - parameters: - - name: ansibleplaybook - in: body - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookCreateRequest" - responses: - 200: - description: 新创建的实例信息 - schema: - $ref: "../schemas/ansibleplaybook.yaml#/AnsiblePlaybookResponse" - tags: - - ansibleplaybooks diff --git a/docs/bucket/access.yaml b/docs/bucket/access.yaml deleted file mode 100644 index 8e1976ed8d..0000000000 --- a/docs/bucket/access.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取存储桶的后端访问信息，例如ceph RADOS的endpint/ak/sk信息等 - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - responses: - 200: - description: 指定存储桶访问信息 - schema: - $ref: "../schemas/bucket.yaml#/BucketAccessInfoResponse" - tags: - - buckets diff --git a/docs/bucket/acl.yaml b/docs/bucket/acl.yaml deleted file mode 100644 index b314aa25bf..0000000000 --- a/docs/bucket/acl.yaml +++ /dev/null @@ -1,32 +0,0 @@ -post: - summary: 设置存储桶或者对象的ACL - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - - name: bucket - in: body - required: true - schema: - $ref: "../schemas/bucket.yaml#/BucketSetACLInput" - responses: - 200: - description: 指定存储桶或者对象的ACL响应 - schema: - $ref: "../schemas/bucket.yaml#/BucketGetResponse" - tags: - - buckets - -get: - summary: 获取存储桶或者对象的ACL - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - - name: key - in: query - type: string - description: 如果查询对象的ACL，通过key指定对象的名称 - responses: - 200: - description: 指定存储桶或者对象的ACL响应 - schema: - $ref: "../schemas/bucket.yaml#/BucketGetACLResponse" - tags: - - buckets diff --git a/docs/bucket/bucket.yaml b/docs/bucket/bucket.yaml deleted file mode 100644 index 2887840117..0000000000 --- a/docs/bucket/bucket.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定对象存储桶的详情 - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - responses: - 200: - description: 对象存储桶信息 - schema: - $ref: "../schemas/bucket.yaml#/BucketGetResponse" - tags: - - buckets - -put: - summary: 更新指定对象存储桶的信息 - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - - name: bucket - in: body - required: true - schema: - $ref: "../schemas/bucket.yaml#/BucketPutRequestInput" - responses: - 200: - description: 对象存储桶信息 - schema: - $ref: "../schemas/bucket.yaml#/BucketGetResponse" - tags: - - buckets - -delete: - summary: 删除指定的对象存储桶 - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - responses: - 200: - description: 被删除的对象存储桶信息 - schema: - $ref: "../schemas/bucket.yaml#/BucketGetResponse" - tags: - - buckets diff --git a/docs/bucket/buckets.yaml b/docs/bucket/buckets.yaml deleted file mode 100644 index 50df6213ad..0000000000 --- a/docs/bucket/buckets.yaml +++ /dev/null @@ -1,32 +0,0 @@ -get: - summary: 按指定条件列出对象存储桶 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/brand' - - $ref: '../parameters/common.yaml#/region' - - $ref: '../parameters/common.yaml#/account' - responses: - 200: - description: 对象存储桶列表信息 - schema: - $ref: "../schemas/bucket.yaml#/BucketListResponse" - tags: - - buckets - -post: - summary: 新建对象存储桶 - parameters: - - name: bucket - in: body - required: true - schema: - $ref: "../schemas/bucket.yaml#/BucketCreateInput" - responses: - 200: - description: 对象存储桶信息 - schema: - $ref: "../schemas/bucket.yaml#/BucketGetResponse" - tags: - - buckets diff --git a/docs/bucket/deleteobjects.yaml b/docs/bucket/deleteobjects.yaml deleted file mode 100644 index 387d965e95..0000000000 --- a/docs/bucket/deleteobjects.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 删除指定桶下的指定对象 - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - - name: bucket - in: body - required: true - schema: - $ref: "../schemas/bucket.yaml#/BucketObjectDeleteInput" - responses: - 200: - description: 对象删除结果 - schema: - $ref: "../schemas/bucket.yaml#/BucketObjectDeleteResponse" - tags: - - buckets diff --git a/docs/bucket/limit.yaml b/docs/bucket/limit.yaml deleted file mode 100644 index 018b6303e1..0000000000 --- a/docs/bucket/limit.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 设置存储桶的储存限制，该限制只有在使用OneCloud作为访问对象存储网关才生效。 - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - - name: bucket - in: body - required: true - schema: - $ref: "../schemas/bucket.yaml#/BucketSetLimitInput" - responses: - 200: - description: 指定存储桶的Limit响应 - schema: - $ref: "../schemas/bucket.yaml#/BucketGetResponse" - tags: - - buckets diff --git a/docs/bucket/listobjects.yaml b/docs/bucket/listobjects.yaml deleted file mode 100644 index e48e8e9213..0000000000 --- a/docs/bucket/listobjects.yaml +++ /dev/null @@ -1,13 +0,0 @@ -get: - summary: 获得指定对象存储桶的对象列表 - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - - $ref: '../parameters/bucket.yaml#/prefix' - - $ref: '../parameters/bucket.yaml#/recursive' - responses: - 200: - description: 对象存储桶的对象列表信息 - schema: - $ref: "../schemas/bucket.yaml#/BucketObjectListResponse" - tags: - - buckets diff --git a/docs/bucket/makedir.yaml b/docs/bucket/makedir.yaml deleted file mode 100644 index c810dcbc81..0000000000 --- a/docs/bucket/makedir.yaml +++ /dev/null @@ -1,14 +0,0 @@ -post: - summary: 创建一个大小为0的对象，用来做目录的占位 - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - - name: bucket - in: body - required: true - schema: - $ref: "../schemas/bucket.yaml#/BucketMakedirInput" - responses: - 200: - description: 创建成功 - tags: - - buckets diff --git a/docs/bucket/tempurl.yaml b/docs/bucket/tempurl.yaml deleted file mode 100644 index 1c2a2af173..0000000000 --- a/docs/bucket/tempurl.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 生成访问指定对象的临时URL - parameters: - - $ref: '../parameters/bucket.yaml#/bucket_name' - - name: bucket - in: body - required: true - schema: - $ref: "../schemas/bucket.yaml#/BucketObjectTempUrlInput" - responses: - 200: - description: 指定对象的临时URL响应 - schema: - $ref: "../schemas/bucket.yaml#/BucketObjectTempUrlResponse" - tags: - - buckets diff --git a/docs/bucket/uploadobject.yaml b/docs/bucket/uploadobject.yaml deleted file mode 100644 index a078a49729..0000000000 --- a/docs/bucket/uploadobject.yaml +++ /dev/null @@ -1,14 +0,0 @@ -post: - summary: 上传对象 - parameters: - - $ref: "../parameters/bucket.yaml#/bucket_name" - - $ref: "../parameters/bucket.yaml#/x-bucket-object-key" - - $ref: "../parameters/bucket.yaml#/x-bucket-content-type" - - $ref: "../parameters/bucket.yaml#/x-bucket-content-length" - - $ref: "../parameters/bucket.yaml#/x-bucket-storage-class" - - $ref: "../parameters/bucket.yaml#/x-bucket-acl" - responses: - 200: - description: 上传成功 - tags: - - buckets diff --git a/docs/build/build-host-image.md b/docs/build/build-host-image.md deleted file mode 100644 index 976ee34721..0000000000 --- a/docs/build/build-host-image.md +++ /dev/null @@ -1,61 +0,0 @@ -# 制作 host-image - -目前 host-image 依赖 qemu 的 libqemuio.a 的静态库，制作相对麻烦，流程如下： - -- 需要准备 arm64 和 x86_64 两台架构的编译机器 -- clone qemu 代码，编译 libqemuio.a -- 两台不通架构的机器分别制作 arm64 和 x86_64 的 host-image 镜像 -- 把 arm64 和 x86_64 的镜像 manifest 打包到一块 - -## 编译 libqemuio.a - -下面是在 arm64 的机器上编译，x86_64 的机器上也是同样的步骤。 - -```bash -# clone qemu 代码 -$ git clone ssh://git@git.yunion.io/cloud/qemu.git && cd qemu - -# libqemuio 代码在 release/2.9 分支 -$ git checkout release/2.9 - -# 使用 docker 编译 libqemuio.a -$ docker run --network host -v $(pwd):/root/qemu -it debian:10 -root@ampere:/$ sed -i 's|http://deb.debian.org|http://mirrors.aliyun.com|g' /etc/apt/sources.list -root@ampere:/$ apt-get update -root@ampere:/$ apt-get install -y gcc make python pkg-config flex bison libpixman-1-dev libudev-dev libaio-dev libcurl4-openssl-dev zlib1g-dev libglib2.0-dev libusb-1.0-0-dev libusbredirparser-dev libusbredirhost-dev libcapstone-dev libcephfs-dev librbd-dev librados-dev libspice-server-dev libspice-protocol-dev libfdt-dev -root@ampere:/$ cd /root/qemu/src && make clean -root@ampere:~/qemu/src$ ./configure --target-list=aarch64-softmmu --enable-libusb --extra-ldflags=-lrt --enable-spice --enable-rbd -root@ampere:~/qemu/src$ make libqemuio.a - -# 然后退出 docker，libqemuio.a 已经编译在 qemu/src 目录里面了 -``` - -## 编译 host-image 镜像 - -libqemuio.a 编译出来后，开始编译 host-image 镜像，需要设置 LIBQEMUIO_PATH 这个环境变量。 -下面是在 arm64 的机器上编译，x86_64 的机器上也是同样的步骤。 - -```bash -# 假设 libqemuio.a 的 qemu 代码在 /root/go/src/yunion.io/x/qemu -$ export LIBQEMUIO_PATH=/root/go/src/yunion.io/x/qemu - -# 这条 make image host-image 的命令会根据当前架构生成 tag=$VERSION-$arch 的镜像 -$ VERSION=dev-test make image host-image -.... -Digest: sha256:3f92e5878e319326f5307f44daef137ded4d43564bfe7091ee2b83111fa282a4 -Status: Downloaded newer image for registry.cn-beijing.aliyuncs.com/yunionio/host-image:dev-test-arm64 -registry.cn-beijing.aliyuncs.com/yunionio/host-image:dev-test-arm64 - -# 如果在 x86_64 上编译，就会生成 registry.cn-beijing.aliyuncs.com/yunionio/host-image:dev-test-amd64 的镜像 -``` - -## 把 arm64 和 x86_64 的镜像 bundle 在一起 - -通过上面两个步骤把 x86_64 和 arm64 的 host-image 做出来后，需要把它们 manifest bundle 到一块，命令如下： - -```bash -$ cd build/docker -$ HOST_IMAGE_VERSION=dev-test make host-image -``` - -这条命令会把 registry.cn-beijing.aliyuncs.com/yunionio/host-image:dev-test-amd64 和 registry.cn-beijing.aliyuncs.com/yunionio/host-image:dev-test-arm64 两个镜像 manifest bundle 到一个叫做 registry.cn-beijing.aliyuncs.com/yunionio/host-image:dev-test 的镜像，这个镜像就可以同时给 arm64 和 x86_64 使用了。 diff --git a/docs/cloudaccount/change-project.yaml b/docs/cloudaccount/change-project.yaml deleted file mode 100644 index 2a2875c741..0000000000 --- a/docs/cloudaccount/change-project.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 更新云账号所属项目 - parameters: - - $ref: '../parameters/cloudaccount.yaml#/cloudaccountId' - - in: body - name: cloudaccount - required: true - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountChangeProject' - responses: - 200: - description: 云账号信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountResponse' - tags: - - cloudaccount \ No newline at end of file diff --git a/docs/cloudaccount/cloudaccount.yaml b/docs/cloudaccount/cloudaccount.yaml deleted file mode 100644 index 28ad5fda69..0000000000 --- a/docs/cloudaccount/cloudaccount.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获取指定云账号详情信息 - parameters: - - $ref: '../parameters/cloudaccount.yaml#/cloudaccountId' - responses: - 200: - description: 云账号信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountResponse' - tags: - - cloudaccount - -put: - summary: 更新云账号信息 - parameters: - - $ref: '../parameters/cloudaccount.yaml#/cloudaccountId' - - in: body - name: cloudaccount - required: true - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountUpdate' - responses: - 200: - description: 云账号信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountResponse' - tags: - - cloudaccount - -delete: - summary: 删除指定云账号 - parameters: - - $ref: '../parameters/cloudaccount.yaml#/cloudaccountId' - responses: - 200: - description: 被删除云账号信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountResponse' - tags: - - cloudaccount \ No newline at end of file diff --git a/docs/cloudaccount/cloudaccounts.yaml b/docs/cloudaccount/cloudaccounts.yaml deleted file mode 100644 index dcb4c145eb..0000000000 --- a/docs/cloudaccount/cloudaccounts.yaml +++ /dev/null @@ -1,30 +0,0 @@ -get: - summary: 按指定条件列出云账号 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/cloud_env' - - responses: - 200: - description: 云账号列表信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountListResponse' - tags: - - cloudaccount -post: - summary: 创建云账号 - parameters: - - in: body - name: cloudaccount - required: true - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountCreate' - responses: - 200: - description: 新创建的云账号信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountResponse' - tags: - - cloudaccount \ No newline at end of file diff --git a/docs/cloudaccount/disable-auto-sync.yaml b/docs/cloudaccount/disable-auto-sync.yaml deleted file mode 100644 index 27c8b61a21..0000000000 --- a/docs/cloudaccount/disable-auto-sync.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 关闭云账号自动同步 - parameters: - - $ref: "../parameters/cloudaccount.yaml#/cloudaccountId" - responses: - 200: - description: 云账号信息 - schema: - $ref: "../schemas/cloudaccount.yaml#/CloudaccountResponse" - - tags: - - cloudaccount diff --git a/docs/cloudaccount/disable.yaml b/docs/cloudaccount/disable.yaml deleted file mode 100644 index adb205ac5f..0000000000 --- a/docs/cloudaccount/disable.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 禁用云账号 - parameters: - - $ref: "../parameters/cloudaccount.yaml#/cloudaccountId" - responses: - 200: - description: 禁用的云账号信息 - schema: - $ref: "../schemas/cloudaccount.yaml#/CloudaccountResponse" - - tags: - - cloudaccount diff --git a/docs/cloudaccount/enable-auto-sync.yaml b/docs/cloudaccount/enable-auto-sync.yaml deleted file mode 100644 index 3132b86a4c..0000000000 --- a/docs/cloudaccount/enable-auto-sync.yaml +++ /dev/null @@ -1,17 +0,0 @@ -post: - summary: 开启云账号自动同步 - parameters: - - $ref: "../parameters/cloudaccount.yaml#/cloudaccountId" - - in: body - name: cloudaccount - required: true - schema: - $ref: "../schemas/cloudaccount.yaml#/CloudaccountEnableAutoSync" - responses: - 200: - description: 云账号信息 - schema: - $ref: "../schemas/cloudaccount.yaml#/CloudaccountResponse" - - tags: - - cloudaccount diff --git a/docs/cloudaccount/enable.yaml b/docs/cloudaccount/enable.yaml deleted file mode 100644 index af70250539..0000000000 --- a/docs/cloudaccount/enable.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 启用云账号 - parameters: - - $ref: "../parameters/cloudaccount.yaml#/cloudaccountId" - responses: - 200: - description: 启用的云账号信息 - schema: - $ref: "../schemas/cloudaccount.yaml#/CloudaccountResponse" - - tags: - - cloudaccount diff --git a/docs/cloudaccount/private.yaml b/docs/cloudaccount/private.yaml deleted file mode 100644 index 0f5e4867ac..0000000000 --- a/docs/cloudaccount/private.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 取消云账号共享 - parameters: - - $ref: "../parameters/cloudaccount.yaml#/cloudaccountId" - responses: - 200: - description: 云账号信息 - schema: - $ref: "../schemas/cloudaccount.yaml#/CloudaccountResponse" - - tags: - - cloudaccount diff --git a/docs/cloudaccount/public.yaml b/docs/cloudaccount/public.yaml deleted file mode 100644 index bcb695155d..0000000000 --- a/docs/cloudaccount/public.yaml +++ /dev/null @@ -1,13 +0,0 @@ -post: - summary: 云账号共享 - parameters: - - $ref: '../parameters/cloudaccount.yaml#/cloudaccountId' - - $ref: "../parameters/cloudaccount.yaml#/scope" - - $ref: "../parameters/cloudaccount.yaml#/shared_projects" - responses: - 200: - description: 云账号信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountResponse' - tags: - - cloudaccount \ No newline at end of file diff --git a/docs/cloudaccount/sync.yaml b/docs/cloudaccount/sync.yaml deleted file mode 100644 index 671d458e1a..0000000000 --- a/docs/cloudaccount/sync.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 云账号信息同步 - parameters: - - $ref: '../parameters/cloudaccount.yaml#/cloudaccountId' - - in: body - name: cloudaccount - required: true - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountSync' - responses: - 200: - description: 云账号信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountResponse' - tags: - - cloudaccount \ No newline at end of file diff --git a/docs/cloudaccount/update-credential.yaml b/docs/cloudaccount/update-credential.yaml deleted file mode 100644 index 0330c3f95c..0000000000 --- a/docs/cloudaccount/update-credential.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 更新云账号密码 - parameters: - - $ref: '../parameters/cloudaccount.yaml#/cloudaccountId' - - in: body - name: cloudaccount - required: true - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountUpdateCredential' - responses: - 200: - description: 云账号信息 - schema: - $ref: '../schemas/cloudaccount.yaml#/CloudaccountResponse' - tags: - - cloudaccount \ No newline at end of file diff --git a/docs/dbinstance/change-config.yaml b/docs/dbinstance/change-config.yaml deleted file mode 100644 index 92e46713d7..0000000000 --- a/docs/dbinstance/change-config.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 调整RDS实例配置 - parameters: - - $ref: "../parameters/dbinstance.yaml#/dbinstanceId" - - in: body - name: dbinstance - required: true - schema: - $ref: "../schemas/dbinstance.yaml#/DBInstanceChangeConfig" - responses: - 200: - description: RDS实例信息 - schema: - $ref: "../schemas/dbinstance.yaml#/DBInstanceResponse" - tags: - - dbinstance diff --git a/docs/dbinstance/dbinstance.yaml b/docs/dbinstance/dbinstance.yaml deleted file mode 100644 index b617559547..0000000000 --- a/docs/dbinstance/dbinstance.yaml +++ /dev/null @@ -1,24 +0,0 @@ -get: - summary: 获取指定RDS实例详情信息 - parameters: - - $ref: '../parameters/dbinstance.yaml#/dbinstanceId' - responses: - 200: - description: RDS实例信息 - schema: - $ref: '../schemas/dbinstance.yaml#/DBInstanceResponse' - tags: - - dbinstance - -delete: - summary: 删除指定RDS实例 - parameters: - - $ref: '../parameters/dbinstance.yaml#/dbinstanceId' - - $ref: '../parameters/dbinstance.yaml#/keep_backup' - responses: - 200: - description: 被删除RDS实例的信息 - schema: - $ref: '../schemas/dbinstance.yaml#/DBInstanceResponse' - tags: - - dbinstance diff --git a/docs/dbinstance/dbinstanceaccount.yaml b/docs/dbinstance/dbinstanceaccount.yaml deleted file mode 100644 index 9636a8caeb..0000000000 --- a/docs/dbinstance/dbinstanceaccount.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定RDS实例用户详情信息 - parameters: - - $ref: '../parameters/dbinstance.yaml#/accountId' - responses: - 200: - description: RDS实例用户信息 - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse' - tags: - - dbinstanceaccount - -delete: - summary: 删除指定RDS实例用户 - parameters: - - $ref: '../parameters/dbinstance.yaml#/accountId' - responses: - 200: - description: 被删除RDS实例的用户信息 - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse' - tags: - - dbinstanceaccount diff --git a/docs/dbinstance/dbinstanceaccounts.yaml b/docs/dbinstance/dbinstanceaccounts.yaml deleted file mode 100644 index a0d17bfe51..0000000000 --- a/docs/dbinstance/dbinstanceaccounts.yaml +++ /dev/null @@ -1,30 +0,0 @@ -get: - summary: 按指定条件列出RDS实例用户列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/dbinstance.yaml#/dbinstance' - - responses: - 200: - description: RDS实例用户列表信息 - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountListResponse' - tags: - - dbinstanceaccount - -post: - summary: 创建RDS实例账号 - parameters: - - in: body - name: dbinstanceaccount - required: true - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountCreate' - responses: - 200: - description: 新建RDS实例账号信息 - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse' - tags: - - dbinstanceaccount diff --git a/docs/dbinstance/dbinstancebackup.yaml b/docs/dbinstance/dbinstancebackup.yaml deleted file mode 100644 index 3130795951..0000000000 --- a/docs/dbinstance/dbinstancebackup.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定RDS实例备份详情信息 - parameters: - - $ref: '../parameters/dbinstance.yaml#/backupId' - responses: - 200: - description: RDS实例备份信息 - schema: - $ref: '../schemas/dbinstance_backup.yaml#/DBInstanceBackupResponse' - tags: - - dbinstancebackup - -delete: - summary: 删除指定RDS实例备份 - parameters: - - $ref: '../parameters/dbinstance.yaml#/backupId' - responses: - 200: - description: 被删除RDS实例的备份信息 - schema: - $ref: '../schemas/dbinstance_backup.yaml#/DBInstanceBackupResponse' - tags: - - dbinstancebackup diff --git a/docs/dbinstance/dbinstancebackups.yaml b/docs/dbinstance/dbinstancebackups.yaml deleted file mode 100644 index 5b2f01d14d..0000000000 --- a/docs/dbinstance/dbinstancebackups.yaml +++ /dev/null @@ -1,16 +0,0 @@ -get: - summary: 按指定条件列出RDS实例备份列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/cloudregion' - - $ref: '../parameters/dbinstance.yaml#/dbinstance' - - - responses: - 200: - description: RDS实例备份列表信息 - schema: - $ref: '../schemas/dbinstance_backup.yaml#/DBInstanceBackupListResponse' - tags: - - dbinstancebackup diff --git a/docs/dbinstance/dbinstancedatabase.yaml b/docs/dbinstance/dbinstancedatabase.yaml deleted file mode 100644 index c65804119e..0000000000 --- a/docs/dbinstance/dbinstancedatabase.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定RDS实例数据库详情信息 - parameters: - - $ref: '../parameters/dbinstance.yaml#/databaseId' - responses: - 200: - description: RDS实例数据库信息 - schema: - $ref: '../schemas/dbinstance_database.yaml#/DBInstanceDatabaseResponse' - tags: - - dbinstancedatabase - -delete: - summary: 删除指定RDS实例数据库 - parameters: - - $ref: '../parameters/dbinstance.yaml#/databaseId' - responses: - 200: - description: 被删除RDS实例的数据库信息 - schema: - $ref: '../schemas/dbinstance_database.yaml#/DBInstanceDatabaseResponse' - tags: - - dbinstancedatabase diff --git a/docs/dbinstance/dbinstancedatabases.yaml b/docs/dbinstance/dbinstancedatabases.yaml deleted file mode 100644 index c1b0e3558e..0000000000 --- a/docs/dbinstance/dbinstancedatabases.yaml +++ /dev/null @@ -1,14 +0,0 @@ -get: - summary: 按指定条件列出RDS实例数据库列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/dbinstance.yaml#/dbinstance' - - responses: - 200: - description: RDS实例数据库列表信息 - schema: - $ref: '../schemas/dbinstance_database.yaml#/DBInstanceDatabaseListResponse' - tags: - - dbinstancedatabase diff --git a/docs/dbinstance/dbinstancenetwork.yaml b/docs/dbinstance/dbinstancenetwork.yaml deleted file mode 100644 index c5711cf9a7..0000000000 --- a/docs/dbinstance/dbinstancenetwork.yaml +++ /dev/null @@ -1,12 +0,0 @@ -get: - summary: 列出指定RDS实例网络信息 - parameters: - - $ref: "../parameters/dbinstance.yaml#/dbinstanceId" - - responses: - 200: - description: RDS实例网络列表信息 - schema: - $ref: '../schemas/dbinstance_network.yaml#/DBInstanceNetworkListResponse' - tags: - - dbinstance diff --git a/docs/dbinstance/dbinstancenetworks.yaml b/docs/dbinstance/dbinstancenetworks.yaml deleted file mode 100644 index dfa4712078..0000000000 --- a/docs/dbinstance/dbinstancenetworks.yaml +++ /dev/null @@ -1,13 +0,0 @@ -get: - summary: 按指定条件列出RDS实例网络信息 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - responses: - 200: - description: RDS实例网络列表信息 - schema: - $ref: '../schemas/dbinstance_network.yaml#/DBInstanceNetworkListResponse' - tags: - - dbinstancenetwork diff --git a/docs/dbinstance/dbinstanceparameter.yaml b/docs/dbinstance/dbinstanceparameter.yaml deleted file mode 100644 index 747ac5578d..0000000000 --- a/docs/dbinstance/dbinstanceparameter.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定RDS实例参数详情信息 - parameters: - - $ref: '../parameters/dbinstance.yaml#/parameterId' - responses: - 200: - description: RDS实例信息 - schema: - $ref: '../schemas/dbinstance_parameter.yaml#/DBInstanceParameterResponse' - tags: - - dbinstanceparameter - -delete: - summary: 删除指定RDS实例参数 - parameters: - - $ref: '../parameters/dbinstance.yaml#/parameterId' - responses: - 200: - description: 被删除RDS实例的参数信息 - schema: - $ref: '../schemas/dbinstance_parameter.yaml#/DBInstanceParameterResponse' - tags: - - dbinstanceparameter diff --git a/docs/dbinstance/dbinstanceparameters.yaml b/docs/dbinstance/dbinstanceparameters.yaml deleted file mode 100644 index a9240f52ab..0000000000 --- a/docs/dbinstance/dbinstanceparameters.yaml +++ /dev/null @@ -1,14 +0,0 @@ -get: - summary: 按指定条件列出RDS实例参数列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/dbinstance.yaml#/dbinstance' - - responses: - 200: - description: RDS实例参数列表信息 - schema: - $ref: '../schemas/dbinstance_parameter.yaml#/DBInstanceParameterListResponse' - tags: - - dbinstanceparameter diff --git a/docs/dbinstance/dbinstances.yaml b/docs/dbinstance/dbinstances.yaml deleted file mode 100644 index eaad4213cd..0000000000 --- a/docs/dbinstance/dbinstances.yaml +++ /dev/null @@ -1,36 +0,0 @@ -get: - summary: 按指定条件列出RDS实例 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/account' - - $ref: '../parameters/common.yaml#/cloudprovider' - - $ref: '../parameters/common.yaml#/billing_type' - - $ref: '../parameters/common.yaml#/cloudregion' - - $ref: '../parameters/common.yaml#/zone' - - $ref: '../parameters/common.yaml#/vpc' - - responses: - 200: - description: RDS实例列表信息 - schema: - $ref: '../schemas/dbinstance.yaml#/DBInstanceListResponse' - tags: - - dbinstance - -post: - summary: 创建RDS实例 - parameters: - - in: body - name: dbinstance - required: true - schema: - $ref: '../schemas/dbinstance.yaml#/DBInstanceCreate' - responses: - 200: - description: 新建RDS实例信息 - schema: - $ref: '../schemas/dbinstance.yaml#/DBInstanceResponse' - tags: - - dbinstance diff --git a/docs/dbinstance/public-connection.yaml b/docs/dbinstance/public-connection.yaml deleted file mode 100644 index 4c9195b28e..0000000000 --- a/docs/dbinstance/public-connection.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 开放关闭RDS实例外网地址 - parameters: - - $ref: "../parameters/dbinstance.yaml#/dbinstanceId" - - in: body - name: dbinstance - required: true - schema: - $ref: "../schemas/dbinstance.yaml#/DBInstancePublicConnection" - responses: - 200: - description: RDS实例信息 - schema: - $ref: "../schemas/dbinstance.yaml#/DBInstanceResponse" - tags: - - dbinstance diff --git a/docs/dbinstance/purge.yaml b/docs/dbinstance/purge.yaml deleted file mode 100644 index 91f7e2b61d..0000000000 --- a/docs/dbinstance/purge.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 抹除RDS实例 - description: 仅删除本地数据库记录，不删除公有云RDS实例 - parameters: - - $ref: '../parameters/dbinstance.yaml#/dbinstanceId' - responses: - 200: - description: RDS实例信息 - schema: - $ref: '../schemas/dbinstance.yaml#/DBInstanceResponse' - tags: - - dbinstance diff --git a/docs/dbinstance/reboot.yaml b/docs/dbinstance/reboot.yaml deleted file mode 100644 index 52f6a13dd4..0000000000 --- a/docs/dbinstance/reboot.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 重启RDS实例 - description: 要求RDS实例状态正常或重启失败 - parameters: - - $ref: '../parameters/dbinstance.yaml#/dbinstanceId' - responses: - 200: - description: RDS实例信息 - schema: - $ref: '../schemas/dbinstance.yaml#/DBInstanceResponse' - tags: - - dbinstance diff --git a/docs/dbinstance/recovery.yaml b/docs/dbinstance/recovery.yaml deleted file mode 100644 index 97db12cc8f..0000000000 --- a/docs/dbinstance/recovery.yaml +++ /dev/null @@ -1,17 +0,0 @@ -post: - summary: 从备份恢复实例数据库 - description: 要求RDS实例状态正常 - parameters: - - $ref: "../parameters/dbinstance.yaml#/dbinstanceId" - - in: body - name: dbinstance - required: true - schema: - $ref: "../schemas/dbinstance.yaml#/DBInstanceRecovery" - responses: - 200: - description: RDS实例信息 - schema: - $ref: "../schemas/dbinstance.yaml#/DBInstanceResponse" - tags: - - dbinstance diff --git a/docs/dbinstance/sync-status.yaml b/docs/dbinstance/sync-status.yaml deleted file mode 100644 index b1f4ca28ed..0000000000 --- a/docs/dbinstance/sync-status.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 同步RDS实例状态 - parameters: - - $ref: '../parameters/dbinstance.yaml#/dbinstanceId' - responses: - 200: - description: RDS实例信息 - schema: - $ref: '../schemas/dbinstance.yaml#/DBInstanceResponse' - tags: - - dbinstance diff --git a/docs/dbinstance_sku/dbinstance_sku.yaml b/docs/dbinstance_sku/dbinstance_sku.yaml deleted file mode 100644 index 795cdae502..0000000000 --- a/docs/dbinstance_sku/dbinstance_sku.yaml +++ /dev/null @@ -1,12 +0,0 @@ -get: - summary: 获取指定RDS套餐详情信息 - parameters: - - $ref: '../parameters/dbinstance_sku.yaml#/skuId' - responses: - 200: - description: RDS套餐信息 - schema: - $ref: '../schemas/dbinstance_sku.yaml#/DBInstanceSkuResponse' - tags: - - dbinstance-sku - diff --git a/docs/dbinstance_sku/dbinstance_skus.yaml b/docs/dbinstance_sku/dbinstance_skus.yaml deleted file mode 100644 index ca873d36cc..0000000000 --- a/docs/dbinstance_sku/dbinstance_skus.yaml +++ /dev/null @@ -1,15 +0,0 @@ -get: - summary: 按指定条件列出RDS套餐 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/cloudregion' - responses: - 200: - description: RDS套餐列表信息 - schema: - $ref: "../schemas/dbinstance_sku.yaml#/DBInstanceSkuListResponse" - tags: - - dbinstance-sku - diff --git a/docs/dbinstanceaccount/account.yaml b/docs/dbinstanceaccount/account.yaml deleted file mode 100644 index 9636a8caeb..0000000000 --- a/docs/dbinstanceaccount/account.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定RDS实例用户详情信息 - parameters: - - $ref: '../parameters/dbinstance.yaml#/accountId' - responses: - 200: - description: RDS实例用户信息 - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse' - tags: - - dbinstanceaccount - -delete: - summary: 删除指定RDS实例用户 - parameters: - - $ref: '../parameters/dbinstance.yaml#/accountId' - responses: - 200: - description: 被删除RDS实例的用户信息 - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse' - tags: - - dbinstanceaccount diff --git a/docs/dbinstanceaccount/accounts.yaml b/docs/dbinstanceaccount/accounts.yaml deleted file mode 100644 index a0d17bfe51..0000000000 --- a/docs/dbinstanceaccount/accounts.yaml +++ /dev/null @@ -1,30 +0,0 @@ -get: - summary: 按指定条件列出RDS实例用户列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/dbinstance.yaml#/dbinstance' - - responses: - 200: - description: RDS实例用户列表信息 - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountListResponse' - tags: - - dbinstanceaccount - -post: - summary: 创建RDS实例账号 - parameters: - - in: body - name: dbinstanceaccount - required: true - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountCreate' - responses: - 200: - description: 新建RDS实例账号信息 - schema: - $ref: '../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse' - tags: - - dbinstanceaccount diff --git a/docs/dbinstanceaccount/grant-privilege.yaml b/docs/dbinstanceaccount/grant-privilege.yaml deleted file mode 100644 index 0b357cac50..0000000000 --- a/docs/dbinstanceaccount/grant-privilege.yaml +++ /dev/null @@ -1,17 +0,0 @@ -post: - summary: 赋予RDS实例的数据库权限 - description: 要求RDS实例状态正常 - parameters: - - $ref: "../parameters/dbinstance.yaml#/accountId" - - in: body - name: dbinstanceaccount - required: true - schema: - $ref: "../schemas/dbinstance_account.yaml#/DBInstanceAccountGrantPrivilege" - responses: - 200: - description: RDS实例账户信息 - schema: - $ref: "../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse" - tags: - - dbinstanceaccount diff --git a/docs/dbinstanceaccount/reset-password.yaml b/docs/dbinstanceaccount/reset-password.yaml deleted file mode 100644 index 8a9974fd58..0000000000 --- a/docs/dbinstanceaccount/reset-password.yaml +++ /dev/null @@ -1,17 +0,0 @@ -post: - summary: 重置RDS实例用户密码 - description: 要求RDS实例状态正常 - parameters: - - $ref: "../parameters/dbinstance.yaml#/accountId" - - in: body - name: dbinstanceaccount - required: true - schema: - $ref: "../schemas/dbinstance_account.yaml#/DBInstanceAccountResetPassword" - responses: - 200: - description: RDS实例账户信息 - schema: - $ref: "../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse" - tags: - - dbinstanceaccount diff --git a/docs/dbinstanceaccount/revoke-privilege.yaml b/docs/dbinstanceaccount/revoke-privilege.yaml deleted file mode 100644 index 550ff5f924..0000000000 --- a/docs/dbinstanceaccount/revoke-privilege.yaml +++ /dev/null @@ -1,17 +0,0 @@ -post: - summary: 解除RDS实例的数据库权限 - description: 要求RDS实例状态正常 - parameters: - - $ref: "../parameters/dbinstance.yaml#/accountId" - - in: body - name: dbinstanceaccount - required: true - schema: - $ref: "../schemas/dbinstance_account.yaml#/DBInstanceAccountRevokePrivilege" - responses: - 200: - description: RDS实例账户信息 - schema: - $ref: "../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse" - tags: - - dbinstanceaccount diff --git a/docs/dbinstanceaccount/set-privileges.yaml b/docs/dbinstanceaccount/set-privileges.yaml deleted file mode 100644 index 63a03a27d9..0000000000 --- a/docs/dbinstanceaccount/set-privileges.yaml +++ /dev/null @@ -1,17 +0,0 @@ -post: - summary: 设置RDS实例的数据库权限 - description: 要求RDS实例及账号状态正常 - parameters: - - $ref: "../parameters/dbinstance.yaml#/accountId" - - in: body - name: dbinstanceaccount - required: true - schema: - $ref: "../schemas/dbinstance_account.yaml#/DBInstanceAccountSetPrivileges" - responses: - 200: - description: RDS实例账户信息 - schema: - $ref: "../schemas/dbinstance_account.yaml#/DBInstanceAccountResponse" - tags: - - dbinstanceaccount diff --git a/docs/dbinstancebackup/backup.yaml b/docs/dbinstancebackup/backup.yaml deleted file mode 100644 index 3130795951..0000000000 --- a/docs/dbinstancebackup/backup.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定RDS实例备份详情信息 - parameters: - - $ref: '../parameters/dbinstance.yaml#/backupId' - responses: - 200: - description: RDS实例备份信息 - schema: - $ref: '../schemas/dbinstance_backup.yaml#/DBInstanceBackupResponse' - tags: - - dbinstancebackup - -delete: - summary: 删除指定RDS实例备份 - parameters: - - $ref: '../parameters/dbinstance.yaml#/backupId' - responses: - 200: - description: 被删除RDS实例的备份信息 - schema: - $ref: '../schemas/dbinstance_backup.yaml#/DBInstanceBackupResponse' - tags: - - dbinstancebackup diff --git a/docs/dbinstancebackup/backups.yaml b/docs/dbinstancebackup/backups.yaml deleted file mode 100644 index 56ba7ee67d..0000000000 --- a/docs/dbinstancebackup/backups.yaml +++ /dev/null @@ -1,32 +0,0 @@ -get: - summary: 按指定条件列出RDS实例备份列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/cloudregion' - - $ref: '../parameters/dbinstance.yaml#/dbinstance' - - - responses: - 200: - description: RDS实例备份列表信息 - schema: - $ref: '../schemas/dbinstance_backup.yaml#/DBInstanceBackupListResponse' - tags: - - dbinstancebackup - -post: - summary: 创建RDS实例备份 - parameters: - - in: body - name: dbinstancebackup - required: true - schema: - $ref: '../schemas/dbinstance_backup.yaml#/DBInstanceBackupCreate' - responses: - 200: - description: 新建RDS实例账号信息 - schema: - $ref: '../schemas/dbinstance_backup.yaml#/DBInstanceBackupResponse' - tags: - - dbinstancebackup diff --git a/docs/dbinstancedatabase/database.yaml b/docs/dbinstancedatabase/database.yaml deleted file mode 100644 index c65804119e..0000000000 --- a/docs/dbinstancedatabase/database.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定RDS实例数据库详情信息 - parameters: - - $ref: '../parameters/dbinstance.yaml#/databaseId' - responses: - 200: - description: RDS实例数据库信息 - schema: - $ref: '../schemas/dbinstance_database.yaml#/DBInstanceDatabaseResponse' - tags: - - dbinstancedatabase - -delete: - summary: 删除指定RDS实例数据库 - parameters: - - $ref: '../parameters/dbinstance.yaml#/databaseId' - responses: - 200: - description: 被删除RDS实例的数据库信息 - schema: - $ref: '../schemas/dbinstance_database.yaml#/DBInstanceDatabaseResponse' - tags: - - dbinstancedatabase diff --git a/docs/dbinstancedatabase/databases.yaml b/docs/dbinstancedatabase/databases.yaml deleted file mode 100644 index 034d6aeb89..0000000000 --- a/docs/dbinstancedatabase/databases.yaml +++ /dev/null @@ -1,30 +0,0 @@ -get: - summary: 按指定条件列出RDS实例数据库列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/dbinstance.yaml#/dbinstance' - - responses: - 200: - description: RDS实例数据库列表信息 - schema: - $ref: '../schemas/dbinstance_database.yaml#/DBInstanceDatabaseListResponse' - tags: - - dbinstancedatabase - -post: - summary: 创建RDS实例数据库 - parameters: - - in: body - name: dbinstancedatabase - required: true - schema: - $ref: '../schemas/dbinstance_database.yaml#/DBInstanceDatabaseCreate' - responses: - 200: - description: 新建RDS实例数据库信息 - schema: - $ref: '../schemas/dbinstance_database.yaml#/DBInstanceDatabaseResponse' - tags: - - dbinstancedatabase diff --git a/docs/disk/create-snapshot.yaml b/docs/disk/create-snapshot.yaml deleted file mode 100644 index 574a0591bc..0000000000 --- a/docs/disk/create-snapshot.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 磁盘创建快照 - parameters: - - $ref: '../parameters/disk.yaml#/diskId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/disk.yaml#/DiskCreateSanpshot' - responses: - 200: - description: 磁盘信息 - schema: - $ref: '../schemas/disk.yaml#/DiskResponse' - tags: - - disk \ No newline at end of file diff --git a/docs/disk/disk.yaml b/docs/disk/disk.yaml deleted file mode 100644 index b60e162562..0000000000 --- a/docs/disk/disk.yaml +++ /dev/null @@ -1,39 +0,0 @@ -get: - summary: 获取指定磁盘详情信息 - parameters: - - $ref: '../parameters/disk.yaml#/diskId' - responses: - 200: - description: 磁盘信息 - schema: - $ref: '../schemas/disk.yaml#/DiskResponse' - tags: - - disk -put: - summary: 更新磁盘信息 - parameters: - - $ref: '../parameters/disk.yaml#/diskId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/disk.yaml#/DiskUpdate' - responses: - 200: - description: 磁盘信息 - schema: - $ref: '../schemas/disk.yaml#/DiskResponse' - tags: - - disk -delete: - summary: 删除指定磁盘 - parameters: - - $ref: '../parameters/disk.yaml#/diskId' - - $ref: '../parameters/common.yaml#/override_pending_delete' - responses: - 200: - description: 被删除磁盘的信息,删除前确保已解除删除保护,第一次删除时会先进入回收站(可恢复),第二次删除会真正释放资源 - schema: - $ref: '../schemas/disk.yaml#/DiskResponse' - tags: - - disk \ No newline at end of file diff --git a/docs/disk/disks.yaml b/docs/disk/disks.yaml deleted file mode 100644 index 639702128a..0000000000 --- a/docs/disk/disks.yaml +++ /dev/null @@ -1,37 +0,0 @@ -get: - summary: 按指定条件列出磁盘 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/pending_delete' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/billing_type' - - $ref: '../parameters/disk.yaml#/unused' - - $ref: '../parameters/disk.yaml#/share' - - $ref: '../parameters/disk.yaml#/local' - - $ref: '../parameters/disk.yaml#/guest' - - $ref: '../parameters/disk.yaml#/storage' - - $ref: '../parameters/disk.yaml#/type' - - $ref: '../parameters/disk.yaml#/cloud_type' - responses: - 200: - description: 磁盘列表信息 - schema: - $ref: "../schemas/disk.yaml#/DiskListResponse" - tags: - - disk -post: - summary: 创建磁盘 - parameters: - - in: body - name: disk - required: true - schema: - $ref: '../schemas/disk.yaml#/DiskCreate' - responses: - 200: - description: 新建磁盘信息 - schema: - $ref: '../schemas/disk.yaml#/DiskResponse' - tags: - - disk \ No newline at end of file diff --git a/docs/disk/private.yaml b/docs/disk/private.yaml deleted file mode 100644 index 497f968541..0000000000 --- a/docs/disk/private.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 取消磁盘共享 - parameters: - - $ref: "../parameters/disk.yaml#/diskId" - responses: - 200: - description: 磁盘信息 - schema: - $ref: "../schemas/disk.yaml#/DiskResponse" - tags: - - disk diff --git a/docs/disk/public.yaml b/docs/disk/public.yaml deleted file mode 100644 index b8882516e8..0000000000 --- a/docs/disk/public.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 磁盘共享 - parameters: - - $ref: "../parameters/disk.yaml#/diskId" - responses: - 200: - description: 磁盘信息 - schema: - $ref: "../schemas/disk.yaml#/DiskResponse" - - tags: - - disk diff --git a/docs/disk/purge.yaml b/docs/disk/purge.yaml deleted file mode 100644 index 5a14452e5d..0000000000 --- a/docs/disk/purge.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 清除磁盘数据库记录 - parameters: - - $ref: "../parameters/disk.yaml#/diskId" - responses: - 200: - description: 磁盘信息 - schema: - $ref: "../schemas/disk.yaml#/DiskResponse" - - tags: - - disk diff --git a/docs/disk/reset.yaml b/docs/disk/reset.yaml deleted file mode 100644 index 41807b49ab..0000000000 --- a/docs/disk/reset.yaml +++ /dev/null @@ -1,17 +0,0 @@ -post: - summary: 回滚磁盘到指定快照 - parameters: - - $ref: "../parameters/disk.yaml#/diskId" - - in: body - name: disk - required: true - schema: - $ref: "../schemas/disk.yaml#/DiskReset" - responses: - 200: - description: 磁盘信息 - schema: - $ref: "../schemas/disk.yaml#/DiskResponse" - - tags: - - disk diff --git a/docs/disk/resize.yaml b/docs/disk/resize.yaml deleted file mode 100644 index ea24675244..0000000000 --- a/docs/disk/resize.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 扩容磁盘 - parameters: - - $ref: '../parameters/disk.yaml#/diskId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/disk.yaml#/DiskResize' - responses: - 200: - description: 磁盘信息 - schema: - $ref: '../schemas/disk.yaml#/DiskResponse' - tags: - - disk \ No newline at end of file diff --git a/docs/disk/save.yaml b/docs/disk/save.yaml deleted file mode 100644 index c4778540df..0000000000 --- a/docs/disk/save.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 磁盘保存镜像 - parameters: - - $ref: '../parameters/disk.yaml#/diskId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/disk.yaml#/DiskSave' - responses: - 200: - description: 磁盘信息 - schema: - $ref: '../schemas/disk.yaml#/DiskResponse' - tags: - - disk \ No newline at end of file diff --git a/docs/elasticcache/allocate-public-connection.yaml b/docs/elasticcache/allocate-public-connection.yaml deleted file mode 100644 index a615c880b9..0000000000 --- a/docs/elasticcache/allocate-public-connection.yaml +++ /dev/null @@ -1,15 +0,0 @@ -post: - summary: 获取ElasticCache实例公网访问地址 - parameters: - - in: body - name: elasticcache - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAllocatePublicConnection" - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/change-spec.yaml b/docs/elasticcache/change-spec.yaml deleted file mode 100644 index eeec75f2e8..0000000000 --- a/docs/elasticcache/change-spec.yaml +++ /dev/null @@ -1,15 +0,0 @@ -post: - summary: 变更ElasticCache实例规格 - parameters: - - in: body - name: elasticcache - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheChangeSpec" - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/elasticcache.yaml b/docs/elasticcache/elasticcache.yaml deleted file mode 100644 index bd28ad32b1..0000000000 --- a/docs/elasticcache/elasticcache.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定ElasticCache实例详情信息 - parameters: - - $ref: "../parameters/elasticcache.yaml#/elasticcacheId" - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache - -delete: - summary: 删除指定ElasticCache实例 - parameters: - - $ref: "../parameters/elasticcache.yaml#/elasticcacheId" - responses: - 200: - description: 被删除ElasticCache实例的信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/elasticcacheaccount.yaml b/docs/elasticcache/elasticcacheaccount.yaml deleted file mode 100644 index dccff3df9e..0000000000 --- a/docs/elasticcache/elasticcacheaccount.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定ElasticCache实例用户详情信息 - parameters: - - $ref: "../parameters/elasticcache.yaml#/accountId" - responses: - 200: - description: ElasticCache实例用户信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAccountResponse" - tags: - - elasticcacheaccount - -delete: - summary: 删除指定ElasticCache实例用户 - parameters: - - $ref: "../parameters/elasticcache.yaml#/accountId" - responses: - 200: - description: 被删除ElasticCache实例的用户信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAccountResponse" - tags: - - elasticcacheaccount diff --git a/docs/elasticcache/elasticcacheaccounts.yaml b/docs/elasticcache/elasticcacheaccounts.yaml deleted file mode 100644 index 2647e0f7f9..0000000000 --- a/docs/elasticcache/elasticcacheaccounts.yaml +++ /dev/null @@ -1,30 +0,0 @@ -get: - summary: 按指定条件列出ElasticCache实例用户列表 - parameters: - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/elasticcache.yaml#/elasticcache_id" - - responses: - 200: - description: ElasticCache实例用户列表信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAccountListResponse" - tags: - - elasticcacheaccount - -post: - summary: 创建ElasticCache实例管理账号 - parameters: - - in: body - name: elasticcacheaccount - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAccountCreate" - responses: - 200: - description: 新创建的ElasticCache实例账号信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAccountResponse" - tags: - - elasticcacheaccount diff --git a/docs/elasticcache/elasticcacheacl.yaml b/docs/elasticcache/elasticcacheacl.yaml deleted file mode 100644 index c2f47384ed..0000000000 --- a/docs/elasticcache/elasticcacheacl.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获取指定ElasticCache实例访问控制详情信息 - parameters: - - $ref: "../parameters/elasticcache.yaml#/aclId" - responses: - 200: - description: ElasticCache实例访问控制信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAclResponse" - tags: - - elasticcacheacl - -put: - summary: 更新指定ElasticCache实例访问控制 - parameters: - - $ref: "../parameters/elasticcache.yaml#/aclId" - - in: body - name: elasticcacheacl - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAclUpdate" - responses: - 200: - description: 被删除ElasticCache实例的访问控制信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAclResponse" - tags: - - elasticcacheacl - -delete: - summary: 删除指定ElasticCache实例访问控制 - parameters: - - $ref: "../parameters/elasticcache.yaml#/aclId" - responses: - 200: - description: 被删除ElasticCache实例的访问控制信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAclResponse" - tags: - - elasticcacheacl diff --git a/docs/elasticcache/elasticcacheacls.yaml b/docs/elasticcache/elasticcacheacls.yaml deleted file mode 100644 index d39ad142b7..0000000000 --- a/docs/elasticcache/elasticcacheacls.yaml +++ /dev/null @@ -1,30 +0,0 @@ -get: - summary: 按指定条件列出ElasticCache实例访问控制列表 - parameters: - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/elasticcache.yaml#/elasticcache_id" - - responses: - 200: - description: ElasticCache实例访问控制列表信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAclListResponse" - tags: - - elasticcacheacl - -post: - summary: 创建ElasticCache实例ACL - parameters: - - in: body - name: elasticcacheacl - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAclCreate" - responses: - 200: - description: 新创建的ElasticCache实例ACL信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAclResponse" - tags: - - elasticcacheacl diff --git a/docs/elasticcache/elasticcachebackup.yaml b/docs/elasticcache/elasticcachebackup.yaml deleted file mode 100644 index d81088af36..0000000000 --- a/docs/elasticcache/elasticcachebackup.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定ElasticCache实例备份详情信息 - parameters: - - $ref: "../parameters/elasticcache.yaml#/backupId" - responses: - 200: - description: ElasticCache实例备份信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheBackupResponse" - tags: - - elasticcachebackup - -delete: - summary: 删除指定ElasticCache实例备份 - parameters: - - $ref: "../parameters/elasticcache.yaml#/backupId" - responses: - 200: - description: 被删除ElasticCache实例的备份信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheBackupResponse" - tags: - - elasticcachebackup diff --git a/docs/elasticcache/elasticcachebackups.yaml b/docs/elasticcache/elasticcachebackups.yaml deleted file mode 100644 index 8abe35e860..0000000000 --- a/docs/elasticcache/elasticcachebackups.yaml +++ /dev/null @@ -1,25 +0,0 @@ -get: - summary: 按指定条件列出ElasticCache实例备份列表 - parameters: - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/cloudregion" - - $ref: "../parameters/elasticcache.yaml#/elasticcache_id" - - responses: - 200: - description: ElasticCache实例备份列表信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheBackupListResponse" - tags: - - elasticcachebackup - -post: - summary: 创建ElasticCache实例备份 - responses: - 200: - description: 新创建的ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheBackupResponse" - tags: - - elasticcachebackup diff --git a/docs/elasticcache/elasticcacheparameter.yaml b/docs/elasticcache/elasticcacheparameter.yaml deleted file mode 100644 index 86a24fc9f7..0000000000 --- a/docs/elasticcache/elasticcacheparameter.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获取指定ElasticCache实例参数详情信息 - parameters: - - $ref: "../parameters/elasticcache.yaml#/parameterId" - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheParameterResponse" - tags: - - elasticcacheparameter - -put: - summary: 更新ElasticCache实例配置参数 - parameters: - - $ref: "../parameters/elasticcache.yaml#/parameterId" - - in: body - name: elasticcacheparameter - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheParameterUpdate" - responses: - 200: - description: ElasticCache实例配置参数信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheParameterResponse" - tags: - - elasticcacheparameter - -delete: - summary: 删除指定ElasticCache实例参数 - parameters: - - $ref: "../parameters/elasticcache.yaml#/parameterId" - responses: - 200: - description: 被删除ElasticCache实例的参数信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheParameterResponse" - tags: - - elasticcacheparameter diff --git a/docs/elasticcache/elasticcacheparameters.yaml b/docs/elasticcache/elasticcacheparameters.yaml deleted file mode 100644 index a0ceefe94d..0000000000 --- a/docs/elasticcache/elasticcacheparameters.yaml +++ /dev/null @@ -1,14 +0,0 @@ -get: - summary: 按指定条件列出ElasticCache实例参数列表 - parameters: - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/elasticcache.yaml#/elasticcache_id" - - responses: - 200: - description: ElasticCache实例参数列表信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheParameterListResponse" - tags: - - elasticcacheparameter diff --git a/docs/elasticcache/elasticcaches.yaml b/docs/elasticcache/elasticcaches.yaml deleted file mode 100644 index 082ff90bdb..0000000000 --- a/docs/elasticcache/elasticcaches.yaml +++ /dev/null @@ -1,36 +0,0 @@ -get: - summary: 按指定条件列出ElasticCache实例 - parameters: - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/provider" - - $ref: "../parameters/common.yaml#/account" - - $ref: "../parameters/common.yaml#/cloudprovider" - - $ref: "../parameters/common.yaml#/billing_type" - - $ref: "../parameters/common.yaml#/cloudregion" - - $ref: "../parameters/common.yaml#/zone" - - $ref: "../parameters/common.yaml#/vpc" - - responses: - 200: - description: ElasticCache实例列表信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheListResponse" - tags: - - elasticcache - -post: - summary: 创建ElasticCache实例 - parameters: - - in: body - name: elasticcache - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheCreate" - responses: - 200: - description: 新创建的ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/elasticcacheskus.yaml b/docs/elasticcache/elasticcacheskus.yaml deleted file mode 100644 index b6a0458a42..0000000000 --- a/docs/elasticcache/elasticcacheskus.yaml +++ /dev/null @@ -1,19 +0,0 @@ -get: - summary: 按指定条件列出ElasticCaches实例套餐列表 - parameters: - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/provider" - - $ref: "../parameters/common.yaml#/zone" - - $ref: "../parameters/common.yaml#/city" - - $ref: "../parameters/common.yaml#/cloudregion" - - $ref: "../parameters/elasticcache.yaml#/engine_version" - - $ref: "../parameters/elasticcache.yaml#/local_category" - - responses: - 200: - description: ElasticCache实例套餐信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheSkuListResponse" - tags: - - elasticcachesku diff --git a/docs/elasticcache/flush-instance.yaml b/docs/elasticcache/flush-instance.yaml deleted file mode 100644 index c720e038c7..0000000000 --- a/docs/elasticcache/flush-instance.yaml +++ /dev/null @@ -1,9 +0,0 @@ -post: - summary: 清空ElasticCache实例 - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/login-info.yaml b/docs/elasticcache/login-info.yaml deleted file mode 100644 index 7821b8707e..0000000000 --- a/docs/elasticcache/login-info.yaml +++ /dev/null @@ -1,9 +0,0 @@ -get: - summary: 获取指定ElasticCache实例管理员密码 - responses: - 200: - description: ElasticCache实例密码信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheLoginInfoResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/release-public-connection.yaml b/docs/elasticcache/release-public-connection.yaml deleted file mode 100644 index f587c8fee9..0000000000 --- a/docs/elasticcache/release-public-connection.yaml +++ /dev/null @@ -1,9 +0,0 @@ -post: - summary: 释放ElasticCache实例公网访问地址 - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/reset-password.yaml b/docs/elasticcache/reset-password.yaml deleted file mode 100644 index c16e0cd7c8..0000000000 --- a/docs/elasticcache/reset-password.yaml +++ /dev/null @@ -1,15 +0,0 @@ -post: - summary: 重置ElasticCache实例账号密码 - parameters: - - in: body - name: elasticcacheaccount - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResetPassword" - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAccountResponse" - tags: - - elasticcacheaccount diff --git a/docs/elasticcache/restart.yaml b/docs/elasticcache/restart.yaml deleted file mode 100644 index 1b70c928b9..0000000000 --- a/docs/elasticcache/restart.yaml +++ /dev/null @@ -1,9 +0,0 @@ -post: - summary: 重启ElasticCache实例 - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/restore-instance.yaml b/docs/elasticcache/restore-instance.yaml deleted file mode 100644 index a906f41321..0000000000 --- a/docs/elasticcache/restore-instance.yaml +++ /dev/null @@ -1,9 +0,0 @@ -post: - summary: ElasticCache实例备份恢复 - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheBackupResponse" - tags: - - elasticcachebackup diff --git a/docs/elasticcache/set-maintain-time.yaml b/docs/elasticcache/set-maintain-time.yaml deleted file mode 100644 index b1128cd0a2..0000000000 --- a/docs/elasticcache/set-maintain-time.yaml +++ /dev/null @@ -1,15 +0,0 @@ -post: - summary: 设置ElasticCache实例维护时间段 - parameters: - - in: body - name: elasticcache - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheSetMaintainTime" - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/update-auth-mode.yaml b/docs/elasticcache/update-auth-mode.yaml deleted file mode 100644 index 2156f940ae..0000000000 --- a/docs/elasticcache/update-auth-mode.yaml +++ /dev/null @@ -1,15 +0,0 @@ -post: - summary: 设置ElasticCache实例密码认证 - parameters: - - in: body - name: elasticcache - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheAuthMode" - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/update-backup-policy.yaml b/docs/elasticcache/update-backup-policy.yaml deleted file mode 100644 index c1c98c31a1..0000000000 --- a/docs/elasticcache/update-backup-policy.yaml +++ /dev/null @@ -1,15 +0,0 @@ -post: - summary: 设置ElasticCache实例备份策略 - parameters: - - in: body - name: elasticcache - required: true - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheBackupPolicy" - responses: - 200: - description: ElasticCache实例信息 - schema: - $ref: "../schemas/elasticcache.yaml#/ElasticCacheResponse" - tags: - - elasticcache diff --git a/docs/elasticcache/update-instance-parameters.yaml b/docs/elasticcache/update-instance-parameters.yaml deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/elasticip/associate.yaml b/docs/elasticip/associate.yaml deleted file mode 100644 index 8ae065f413..0000000000 --- a/docs/elasticip/associate.yaml +++ /dev/null @@ -1,14 +0,0 @@ -post: - summary: 绑定资源 - parameters: - - $ref: "../parameters/elasticip.yaml#/elasticipId" - - $ref: "../parameters/elasticip.yaml#/instance_id" - - $ref: "../parameters/elasticip.yaml#/instance_type" - responses: - 200: - description: 弹性IP信息 - schema: - $ref: "../schemas/elasticip.yaml#/ElasticIpResponse" - - tags: - - elasticips diff --git a/docs/elasticip/change-bandwidth.yaml b/docs/elasticip/change-bandwidth.yaml deleted file mode 100644 index 4ef31af512..0000000000 --- a/docs/elasticip/change-bandwidth.yaml +++ /dev/null @@ -1,13 +0,0 @@ -post: - summary: 更改弹性IP带宽大小 - parameters: - - $ref: "../parameters/elasticip.yaml#/elasticipId" - - $ref: "../parameters/elasticip.yaml#/bandwidth" - responses: - 200: - description: 弹性IP信息 - schema: - $ref: "../schemas/elasticip.yaml#/ElasticIpResponse" - - tags: - - elasticips diff --git a/docs/elasticip/dissociate.yaml b/docs/elasticip/dissociate.yaml deleted file mode 100644 index 5e33707f06..0000000000 --- a/docs/elasticip/dissociate.yaml +++ /dev/null @@ -1,13 +0,0 @@ -post: - summary: 解绑弹性EIP - parameters: - - $ref: "../parameters/elasticip.yaml#/elasticipId" - - $ref: "../parameters/elasticip.yaml#/auto_delete" - responses: - 200: - description: 弹性IP信息 - schema: - $ref: "../schemas/elasticip.yaml#/ElasticIpResponse" - - tags: - - elasticips diff --git a/docs/elasticip/elasticip.yaml b/docs/elasticip/elasticip.yaml deleted file mode 100644 index dba9436d5c..0000000000 --- a/docs/elasticip/elasticip.yaml +++ /dev/null @@ -1,39 +0,0 @@ -get: - summary: 获取指定弹性IP详情信息 - parameters: - - $ref: "../parameters/elasticip.yaml#/elasticipId" - responses: - 200: - description: 弹性IP详情信息 - schema: - $ref: "../schemas/elasticip.yaml#/ElasticIpResponse" - tags: - - elasticips - -delete: - summary: 删除指定弹性IP - parameters: - - $ref: '../parameters/elasticip.yaml#/elasticipId' - responses: - 200: - schema: - $ref: '../schemas/elasticip.yaml#/ElasticIpResponse' - tags: - - elasticips - -put: - summary: 更新弹性IP信息 - parameters: - - $ref: '../parameters/elasticip.yaml#/elasticipId' - - in: body - name: elasticip - required: true - schema: - $ref: '../schemas/elasticip.yaml#/ElasticIpUpdate' - responses: - 200: - description: 弹性IP信息 - schema: - $ref: '../schemas/elasticip.yaml#/ElasticIpResponse' - tags: - - elasticips \ No newline at end of file diff --git a/docs/elasticip/elasticips.yaml b/docs/elasticip/elasticips.yaml deleted file mode 100644 index b4e80ef523..0000000000 --- a/docs/elasticip/elasticips.yaml +++ /dev/null @@ -1,38 +0,0 @@ -post: - summary: 创建弹性IP - parameters: - - in: body - name: elasticip - required: true - schema: - $ref: '../schemas/elasticip.yaml#/ElasticIpCreate' - responses: - 200: - description: 新建弹性IP的信息 - schema: - $ref: '../schemas/elasticip.yaml#/ElasticIpResponse' - tags: - - elasticips - -get: - summary: 按指定条件列出弹性IP列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/cloudprovider' - - $ref: '../parameters/common.yaml#/cloudaccount' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/brand' - - $ref: '../parameters/common.yaml#/cloud_env' - - $ref: '../parameters/common.yaml#/public_cloud' - - $ref: '../parameters/common.yaml#/private_cloud' - - $ref: '../parameters/elasticip.yaml#/usable_eip_for_associate_type' - - $ref: '../parameters/elasticip.yaml#/usable_eip_for_associate_id' - - $ref: '../parameters/elasticip.yaml#/usable' - responses: - 200: - description: 弹性IP列表信息 - schema: - $ref: '../schemas/elasticip.yaml#/ElasticIpListResponse' - tags: - - elasticips diff --git a/docs/elasticip/purge.yaml b/docs/elasticip/purge.yaml deleted file mode 100644 index 8088db8c74..0000000000 --- a/docs/elasticip/purge.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 清除弹性EIP数据库记录(并不真正删除资源) - parameters: - - $ref: "../parameters/elasticip.yaml#/elasticipId" - responses: - 200: - description: 弹性IP信息 - schema: - $ref: "../schemas/elasticip.yaml#/ElasticIpResponse" - - tags: - - elasticips diff --git a/docs/elasticip/sync.yaml b/docs/elasticip/sync.yaml deleted file mode 100644 index 3d241cbb2a..0000000000 --- a/docs/elasticip/sync.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 同步弹性EIP状态 - parameters: - - $ref: "../parameters/elasticip.yaml#/elasticipId" - responses: - 200: - description: 弹性IP信息 - schema: - $ref: "../schemas/elasticip.yaml#/ElasticIpResponse" - - tags: - - elasticips \ No newline at end of file diff --git a/docs/host/add-netif.yaml b/docs/host/add-netif.yaml deleted file mode 100644 index 6bfee0d9f2..0000000000 --- a/docs/host/add-netif.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 物理机添加网卡 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - - in: body - name: host - required: true - schema: - $ref: "../schemas/host.yaml#/HostAddNetif" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/convert-hypervisor.yaml b/docs/host/convert-hypervisor.yaml deleted file mode 100644 index 9a52e94833..0000000000 --- a/docs/host/convert-hypervisor.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 将物理机转换成宿主机 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - - in: body - name: host - required: true - schema: - $ref: "../schemas/host.yaml#/HostConvertHypervisor" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/disable.yaml b/docs/host/disable.yaml deleted file mode 100644 index a5316f4ecb..0000000000 --- a/docs/host/disable.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 禁用宿主机 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/enable.yaml b/docs/host/enable.yaml deleted file mode 100644 index b49ed4ae26..0000000000 --- a/docs/host/enable.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 启用宿主机 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/host.yaml b/docs/host/host.yaml deleted file mode 100644 index bbd026101b..0000000000 --- a/docs/host/host.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获取指定宿主机详情信息 - parameters: - - $ref: '../parameters/host.yaml#/hostId' - - $ref: '../parameters/common.yaml#/pending_delete' - responses: - 200: - description: 宿主机信息 - schema: - $ref: '../schemas/host.yaml#/HostResponse' - tags: - - host -put: - summary: 更新宿主机信息 - parameters: - - $ref: '../parameters/host.yaml#/hostId' - - in: body - name: host - required: true - schema: - $ref: '../schemas/host.yaml#/HostUpdate' - responses: - 200: - description: 宿主机信息 - schema: - $ref: '../schemas/host.yaml#/HostResponse' - tags: - - host -delete: - summary: 删除指定宿主机 - parameters: - - $ref: '../parameters/host.yaml#/hostId' - - $ref: '../parameters/common.yaml#/override_pending_delete' - responses: - 200: - description: 被删除宿主机的信息,删除前确保已解除删除保护 - schema: - $ref: '../schemas/host.yaml#/HostResponse' - tags: - - host \ No newline at end of file diff --git a/docs/host/hosts.yaml b/docs/host/hosts.yaml deleted file mode 100644 index 47155021c6..0000000000 --- a/docs/host/hosts.yaml +++ /dev/null @@ -1,44 +0,0 @@ -get: - summary: 按指定条件列出宿主机 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/zone' - - $ref: '../parameters/common.yaml#/wire' - - $ref: '../parameters/common.yaml#/vpc' - - $ref: '../parameters/common.yaml#/region' - - $ref: '../parameters/host.yaml#/enable' - - $ref: '../parameters/host.yaml#/disable' - - $ref: '../parameters/host.yaml#/host_type' - - $ref: '../parameters/host.yaml#/is_empty' - - $ref: '../parameters/host.yaml#/storage' - - $ref: '../parameters/host.yaml#/usable' - - $ref: '../parameters/host.yaml#/hypervisor' - - $ref: '../parameters/host.yaml#/any_mac' - - $ref: '../parameters/host.yaml#/cachedimage' - - $ref: '../parameters/host.yaml#/is_baremetal' - - $ref: '../parameters/host.yaml#/resource_type' - - $ref: '../parameters/host.yaml#/storage_not_attached' - responses: - 200: - description: 宿主机列表信息 - schema: - $ref: '../schemas/host.yaml#/HostListResponse' - tags: - - host -post: - summary: 注册物理机 - parameters: - - in: body - name: host - required: true - schema: - $ref: '../schemas/host.yaml#/HostCreate' - responses: - 200: - description: 新创建的宿主机信息 - schema: - $ref: '../schemas/host.yaml#/HostResponse' - tags: - - host \ No newline at end of file diff --git a/docs/host/ipmi.yaml b/docs/host/ipmi.yaml deleted file mode 100644 index 42aa0ee471..0000000000 --- a/docs/host/ipmi.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取物理机IPMI信息 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: ipmi信息 - schema: - $ref: "../schemas/host.yaml#/HostIpmi" - tags: - - host diff --git a/docs/host/maintenance.yaml b/docs/host/maintenance.yaml deleted file mode 100644 index 6d728760d4..0000000000 --- a/docs/host/maintenance.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 重启物理机进入PXE系统，做维护工作 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/ping.yaml b/docs/host/ping.yaml deleted file mode 100644 index 0aa9850471..0000000000 --- a/docs/host/ping.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: ping Host - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/prepare.yaml b/docs/host/prepare.yaml deleted file mode 100644 index 309b5b4879..0000000000 --- a/docs/host/prepare.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 重新收集物理机信息 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/remove-netif.yaml b/docs/host/remove-netif.yaml deleted file mode 100644 index 22bb686744..0000000000 --- a/docs/host/remove-netif.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 物理机删除网卡 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - - in: body - name: host - required: true - schema: - $ref: "../schemas/host.yaml#/HostRemoveNetif" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/renew-prepaid-recycle.yaml b/docs/host/renew-prepaid-recycle.yaml deleted file mode 100644 index b8a1128c94..0000000000 --- a/docs/host/renew-prepaid-recycle.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 为预付费宿主机续费 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/reset.yaml b/docs/host/reset.yaml deleted file mode 100644 index 6d00c7c48b..0000000000 --- a/docs/host/reset.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 物理机重启 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/spec.yaml b/docs/host/spec.yaml deleted file mode 100644 index d91c3f033a..0000000000 --- a/docs/host/spec.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取宿主机缩略信息 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机缩略信息 - schema: - $ref: "../schemas/host.yaml#/HostSpec" - tags: - - host diff --git a/docs/host/start.yaml b/docs/host/start.yaml deleted file mode 100644 index af4df801df..0000000000 --- a/docs/host/start.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 启动物理机 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/stop.yaml b/docs/host/stop.yaml deleted file mode 100644 index 38c87c5597..0000000000 --- a/docs/host/stop.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 物理机关机 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/syncstatus.yaml b/docs/host/syncstatus.yaml deleted file mode 100644 index f4f32b554f..0000000000 --- a/docs/host/syncstatus.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 同步物理机状态 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/undo-convert.yaml b/docs/host/undo-convert.yaml deleted file mode 100644 index c51169c817..0000000000 --- a/docs/host/undo-convert.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 将转换成宿主机的物理机转回成物理机 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/undo-prepaid-recycle.yaml b/docs/host/undo-prepaid-recycle.yaml deleted file mode 100644 index a827a154ee..0000000000 --- a/docs/host/undo-prepaid-recycle.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 从预付费资源池中移除 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/host/unmaintenance.yaml b/docs/host/unmaintenance.yaml deleted file mode 100644 index e24ee1db89..0000000000 --- a/docs/host/unmaintenance.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 重启物理机，进入磁盘安装的操作系统 - parameters: - - $ref: "../parameters/host.yaml#/hostId" - responses: - 200: - description: 宿主机信息 - schema: - $ref: "../schemas/host.yaml#/HostResponse" - tags: - - host diff --git a/docs/hoststorage/hoststorage.yaml b/docs/hoststorage/hoststorage.yaml deleted file mode 100644 index b3d069e353..0000000000 --- a/docs/hoststorage/hoststorage.yaml +++ /dev/null @@ -1,29 +0,0 @@ -get: - summary: 获取宿主机和存储的绑定关系详情信息 - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/hoststorage.yaml#/HostStorageResponse' - tags: - - hoststorages - -post: - summary: 宿主机和存储绑定 - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/hoststorage.yaml#/HostStorageResponse' - tags: - - hoststorages - -delete: - summary: 解除宿主机和存储的绑定关系 - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/hoststorage.yaml#/HostStorageResponse' - tags: - - hoststorages \ No newline at end of file diff --git a/docs/hoststorage/hoststorages.yaml b/docs/hoststorage/hoststorages.yaml deleted file mode 100644 index 36575a5f1d..0000000000 --- a/docs/hoststorage/hoststorages.yaml +++ /dev/null @@ -1,17 +0,0 @@ -get: - summary: 按指定条件列出已经绑定的宿主机和存储 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/zone' - - $ref: '../parameters/common.yaml#/region' - - $ref: '../parameters/common.yaml#/brand' - - $ref: '../parameters/hoststorage.yaml#/storage' - - $ref: '../parameters/hoststorage.yaml#/host' - responses: - 200: - description: 存储列表信息 - schema: - $ref: '../schemas/hoststorage.yaml#/HostStorageListResponse' - tags: - - hoststorages \ No newline at end of file diff --git a/docs/identity/auth_v2.yaml b/docs/identity/auth_v2.yaml deleted file mode 100644 index 8a2e12a407..0000000000 --- a/docs/identity/auth_v2.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: keystone v2认证接口，通过用户名／密码或者token认证 - parameters: - - name: auth - in: body - required: true - schema: - type: object - $ref: "../schemas/auth.yaml#/Auth2Input" - responses: - 200: - description: keystone v2认证信息 - schema: - $ref: "../schemas/auth.yaml#/Auth2Response" - tags: - - authentication diff --git a/docs/identity/auth_v3.yaml b/docs/identity/auth_v3.yaml deleted file mode 100644 index e9607f8161..0000000000 --- a/docs/identity/auth_v3.yaml +++ /dev/null @@ -1,37 +0,0 @@ -get: - summary: keystone v3 token验证API - parameters: - - $ref: '../parameters/auth.yaml#/token3' - responses: - 200: - description: keystone v3 token信息 - headers: - X-Subject-Token: - schema: - type: string - description: 验证成功的token - schema: - $ref: "../schemas/auth.yaml#/Auth3Response" - tags: - - authentication - -post: - summary: keystone v3认证API - parameters: - - name: auth - in: body - required: true - schema: - $ref: "../schemas/auth.yaml#/Auth3Input" - responses: - 200: - description: keystone v3 token信息 - headers: - X-Subject-Token: - schema: - type: string - description: 认证成功的token - schema: - $ref: "../schemas/auth.yaml#/Auth3Response" - tags: - - authentication diff --git a/docs/identity/credentials.yaml b/docs/identity/credentials.yaml deleted file mode 100644 index ebb86cd7f6..0000000000 --- a/docs/identity/credentials.yaml +++ /dev/null @@ -1,12 +0,0 @@ -get: - summary: 按指定条件列出用户credentails - parameters: - - $ref: '../parameters/credential.yaml#/type' - - $ref: '../parameters/credential.yaml#/user_id' - responses: - 200: - description: 用户credential列表信息 - schema: - $ref: "../schemas/credential.yaml#/CredentialListResponse" - tags: - - credentials diff --git a/docs/identity/domain.yaml b/docs/identity/domain.yaml deleted file mode 100644 index 68ccf509a3..0000000000 --- a/docs/identity/domain.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定域的详情 - parameters: - - $ref: '../parameters/domain.yaml#/domain_id' - responses: - 200: - description: 域信息 - schema: - $ref: "../schemas/domain.yaml#/DomainGetResponse" - tags: - - domains - -put: - summary: 更新指定域的字段 - parameters: - - $ref: '../parameters/domain.yaml#/domain_id' - - name: domain - in: body - required: true - schema: - $ref: "../schemas/domain.yaml#/DomainPutRequestInput" - responses: - 200: - description: 域信息 - schema: - $ref: "../schemas/domain.yaml#/DomainGetResponse" - tags: - - domains - -delete: - summary: 删除指定的域 - parameters: - - $ref: '../parameters/domain.yaml#/domain_id' - responses: - 200: - description: 被删除的域信息 - schema: - $ref: "../schemas/domain.yaml#/DomainGetResponse" - tags: - - domains diff --git a/docs/identity/domains.yaml b/docs/identity/domains.yaml deleted file mode 100644 index 4efaa0ffbd..0000000000 --- a/docs/identity/domains.yaml +++ /dev/null @@ -1,29 +0,0 @@ -get: - summary: 按指定条件列出域 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - responses: - 200: - description: 域列表信息 - schema: - $ref: "../schemas/domain.yaml#/DomainListResponse" - tags: - - domains - -post: - summary: 新建域 - parameters: - - name: domain - in: body - required: true - schema: - $ref: "../schemas/domain.yaml#/DomainCreateInput" - responses: - 200: - description: 域信息 - schema: - $ref: "../schemas/domain.yaml#/DomainGetResponse" - tags: - - domains - diff --git a/docs/identity/endpoint.yaml b/docs/identity/endpoint.yaml deleted file mode 100644 index f9a0be201e..0000000000 --- a/docs/identity/endpoint.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定接入点的详情 - parameters: - - $ref: '../parameters/endpoint.yaml#/endpoint_id' - responses: - 200: - description: 接入点信息 - schema: - $ref: "../schemas/endpoint.yaml#/EndpointGetResponse" - tags: - - endpoints - -put: - summary: 更新指定接入点的属性 - parameters: - - $ref: '../parameters/endpoint.yaml#/endpoint_id' - - name: endpoint - in: body - required: true - schema: - $ref: "../schemas/endpoint.yaml#/EndpointPutRequestInput" - responses: - 200: - description: 接入点信息 - schema: - $ref: "../schemas/endpoint.yaml#/EndpointGetResponse" - tags: - - endpoints - -delete: - summary: 删除指定接入点 - parameters: - - $ref: '../parameters/endpoint.yaml#/endpoint_id' - responses: - 200: - description: 被删除的接入点信息 - schema: - $ref: "../schemas/endpoint.yaml#/EndpointGetResponse" - tags: - - endpoints diff --git a/docs/identity/endpoints.yaml b/docs/identity/endpoints.yaml deleted file mode 100644 index d501031c14..0000000000 --- a/docs/identity/endpoints.yaml +++ /dev/null @@ -1,28 +0,0 @@ -get: - summary: 按指定条件列出服务接入点 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - responses: - 200: - description: 接入点列表信息 - schema: - $ref: "../schemas/endpoint.yaml#/EndpointListResponse" - tags: - - endpoints - -post: - summary: 新建一个接入点 - parameters: - - name: endpoint - in: body - required: true - schema: - $ref: "../schemas/endpoint.yaml#/EndpointCreateInput" - responses: - 200: - description: 接入点信息 - schema: - $ref: "../schemas/endpoint.yaml#/EndpointGetResponse" - tags: - - endpoints diff --git a/docs/identity/group.yaml b/docs/identity/group.yaml deleted file mode 100644 index ca751d72b2..0000000000 --- a/docs/identity/group.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定组的详情 - parameters: - - $ref: '../parameters/group.yaml#/group_id' - responses: - 200: - description: 组信息 - schema: - $ref: "../schemas/group.yaml#/GroupGetResponse" - tags: - - groups - -put: - summary: 更新指定组的信息 - parameters: - - $ref: '../parameters/group.yaml#/group_id' - - name: group - in: body - required: true - schema: - $ref: "../schemas/group.yaml#/GroupPutRequestInput" - responses: - 200: - description: 组信息 - schema: - $ref: "../schemas/group.yaml#/GroupGetResponse" - tags: - - groups - -delete: - summary: 删除指定组 - parameters: - - $ref: '../parameters/group.yaml#/group_id' - responses: - 200: - description: 被删除的组信息 - schema: - $ref: "../schemas/group.yaml#/GroupGetResponse" - tags: - - groups diff --git a/docs/identity/group_join.yaml b/docs/identity/group_join.yaml deleted file mode 100644 index 7370da0654..0000000000 --- a/docs/identity/group_join.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 将组以多个角色加入多个项目 - parameters: - - $ref: '../parameters/group.yaml#/group_id' - - name: group - in: body - required: true - schema: - $ref: "../schemas/project.yaml#/ProjectJoinRequestInput" - responses: - 200: - description: 组信息 - schema: - $ref: "../schemas/group.yaml#/GroupGetResponse" - tags: - - groups diff --git a/docs/identity/group_leave.yaml b/docs/identity/group_leave.yaml deleted file mode 100644 index 8830b4d4d8..0000000000 --- a/docs/identity/group_leave.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 将组的多个角色从多个项目中删除 - parameters: - - $ref: '../parameters/group.yaml#/group_id' - - name: group - in: body - required: true - schema: - $ref: "../schemas/project.yaml#/ProjectLeaveRequestInput" - responses: - 200: - description: 组信息 - schema: - $ref: "../schemas/group.yaml#/GroupGetResponse" - tags: - - groups diff --git a/docs/identity/groups.yaml b/docs/identity/groups.yaml deleted file mode 100644 index e0dc140ab4..0000000000 --- a/docs/identity/groups.yaml +++ /dev/null @@ -1,31 +0,0 @@ -get: - summary: 按指定条件列出组 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/scope' - - $ref: '../parameters/identity.yaml#/project_domain' - responses: - 200: - description: 组列表信息 - schema: - $ref: "../schemas/group.yaml#/GroupListResponse" - tags: - - groups - -post: - summary: 新建一个本地组 - parameters: - - name: group - in: body - required: true - schema: - $ref: "../schemas/group.yaml#/GroupCreateInput" - responses: - 200: - description: 组信息 - schema: - $ref: "../schemas/group.yaml#/GroupGetResponse" - tags: - - groups - diff --git a/docs/identity/groupuser.yaml b/docs/identity/groupuser.yaml deleted file mode 100644 index 0e7d42669d..0000000000 --- a/docs/identity/groupuser.yaml +++ /dev/null @@ -1,21 +0,0 @@ -put: - summary: 将用户加入组 - parameters: - - $ref: '../parameters/identity.yaml#/group_id' - - $ref: '../parameters/identity.yaml#/user_id' - responses: - 200: - description: 成功 - tags: - - users - -delete: - summary: 将用户从组中删除 - parameters: - - $ref: '../parameters/identity.yaml#/group_id' - - $ref: '../parameters/identity.yaml#/user_id' - responses: - 200: - description: 成功 - tags: - - users diff --git a/docs/identity/identity_provider.yaml b/docs/identity/identity_provider.yaml deleted file mode 100644 index 9fbd174ccd..0000000000 --- a/docs/identity/identity_provider.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定认证源的详情 - parameters: - - $ref: '../parameters/identity_provider.yaml#/idp_id' - responses: - 200: - description: 认证源信息 - schema: - $ref: "../schemas/identity_provider.yaml#/IdpGetResponse" - tags: - - identity_providers - -put: - summary: 更新指定认证源的字段 - parameters: - - $ref: '../parameters/identity_provider.yaml#/idp_id' - - name: identity_provider - in: body - required: true - schema: - $ref: "../schemas/identity_provider.yaml#/IdpPutRequestInput" - responses: - 200: - description: 认证源信息 - schema: - $ref: "../schemas/identity_provider.yaml#/IdpGetResponse" - tags: - - identity_providers - -delete: - summary: 删除指定的认证源 - parameters: - - $ref: '../parameters/identity_provider.yaml#/idp_id' - responses: - 200: - description: 被删除的认证源信息 - schema: - $ref: "../schemas/identity_provider.yaml#/IdpGetResponse" - tags: - - identity_providers diff --git a/docs/identity/identity_providers.yaml b/docs/identity/identity_providers.yaml deleted file mode 100644 index cfd153f026..0000000000 --- a/docs/identity/identity_providers.yaml +++ /dev/null @@ -1,29 +0,0 @@ -get: - summary: 按指定条件列出认证源 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - responses: - 200: - description: 认证源列表信息 - schema: - $ref: "../schemas/identity_provider.yaml#/IdpListResponse" - tags: - - identity_providers - -post: - summary: 创建认证源 - parameters: - - name: identity_provider - in: body - required: true - schema: - $ref: "../schemas/identity_provider.yaml#/IdpCreateInput" - responses: - 200: - description: 认证源信息 - schema: - $ref: "../schemas/identity_provider.yaml#/IdpGetResponse" - tags: - - identity_providers - diff --git a/docs/identity/policies.yaml b/docs/identity/policies.yaml deleted file mode 100644 index 4e95f29f19..0000000000 --- a/docs/identity/policies.yaml +++ /dev/null @@ -1,31 +0,0 @@ -get: - summary: 按指定过滤条件列出权限 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/scope' - - $ref: '../parameters/identity.yaml#/project_domain' - responses: - 200: - description: 权限列表信息 - schema: - $ref: "../schemas/policy.yaml#/PolicyListResponse" - tags: - - policies - -post: - summary: 新建一个权限 - parameters: - - name: policy - in: body - required: true - schema: - $ref: "../schemas/policy.yaml#/PolicyCreateInput" - responses: - 200: - description: 权限信息 - schema: - $ref: "../schemas/policy.yaml#/PolicyGetResponse" - tags: - - policies - diff --git a/docs/identity/policy.yaml b/docs/identity/policy.yaml deleted file mode 100644 index bdc0cfddb5..0000000000 --- a/docs/identity/policy.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定权限的详情 - parameters: - - $ref: '../parameters/policy.yaml#/policy_id' - responses: - 200: - description: 权限信息 - schema: - $ref: "../schemas/policy.yaml#/PolicyGetResponse" - tags: - - policies - -patch: - summary: 更新指定权限的属性 - parameters: - - $ref: '../parameters/policy.yaml#/policy_id' - - name: policy - in: body - required: true - schema: - $ref: "../schemas/policy.yaml#/PolicyPutRequestInput" - responses: - 200: - description: 权限信息 - schema: - $ref: "../schemas/policy.yaml#/PolicyGetResponse" - tags: - - policies - -delete: - summary: 删除指定权限 - parameters: - - $ref: '../parameters/policy.yaml#/policy_id' - responses: - 200: - description: 被删除的权限信息 - schema: - $ref: "../schemas/policy.yaml#/PolicyGetResponse" - tags: - - policies diff --git a/docs/identity/project.yaml b/docs/identity/project.yaml deleted file mode 100644 index 702e12a54b..0000000000 --- a/docs/identity/project.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定项目的详情 - parameters: - - $ref: '../parameters/project.yaml#/project_id' - responses: - 200: - description: 项目信息 - schema: - $ref: "../schemas/project.yaml#/ProjectGetResponse" - tags: - - projects - -put: - summary: 更新指定项目的属性 - parameters: - - $ref: '../parameters/project.yaml#/project_id' - - name: project - in: body - required: true - schema: - $ref: "../schemas/project.yaml#/ProjectPutRequestInput" - responses: - 200: - description: 项目信息 - schema: - $ref: "../schemas/project.yaml#/ProjectGetResponse" - tags: - - projects - -delete: - summary: 删除指定项目 - parameters: - - $ref: '../parameters/project.yaml#/project_id' - responses: - 200: - description: 被删除的项目信息 - schema: - $ref: "../schemas/project.yaml#/ProjectGetResponse" - tags: - - projects diff --git a/docs/identity/project_join.yaml b/docs/identity/project_join.yaml deleted file mode 100644 index ed03bb1fe4..0000000000 --- a/docs/identity/project_join.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 将多个用户和组以多个角色加入指定项目 - parameters: - - $ref: '../parameters/project.yaml#/project_id' - - name: project - in: body - required: true - schema: - $ref: "../schemas/project.yaml#/ProjectJoinUserGroupRequestInput" - responses: - 200: - description: 项目信息 - schema: - $ref: "../schemas/project.yaml#/ProjectGetResponse" - tags: - - projects diff --git a/docs/identity/project_leave.yaml b/docs/identity/project_leave.yaml deleted file mode 100644 index 32671e0093..0000000000 --- a/docs/identity/project_leave.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 将多个用户和组以多个角色从指定项目删除 - parameters: - - $ref: '../parameters/project.yaml#/project_id' - - name: project - in: body - required: true - schema: - $ref: "../schemas/project.yaml#/ProjectRemoveUserGroupRequestInput" - responses: - 200: - description: 项目信息 - schema: - $ref: "../schemas/project.yaml#/ProjectGetResponse" - tags: - - projects diff --git a/docs/identity/projectgrouprole.yaml b/docs/identity/projectgrouprole.yaml deleted file mode 100644 index ffa9d0cb81..0000000000 --- a/docs/identity/projectgrouprole.yaml +++ /dev/null @@ -1,25 +0,0 @@ -put: - deprecated: true - summary: 将组以指定角色加入项目 - parameters: - - $ref: '../parameters/identity.yaml#/project_id' - - $ref: '../parameters/identity.yaml#/group_id' - - $ref: '../parameters/identity.yaml#/role_id' - responses: - 200: - description: 成功 - tags: - - roles - -delete: - deprecated: true - summary: 将组在项目中的角色删除 - parameters: - - $ref: '../parameters/identity.yaml#/project_id' - - $ref: '../parameters/identity.yaml#/group_id' - - $ref: '../parameters/identity.yaml#/role_id' - responses: - 200: - description: 成功 - tags: - - roles diff --git a/docs/identity/projects.yaml b/docs/identity/projects.yaml deleted file mode 100644 index 30cf0ecda4..0000000000 --- a/docs/identity/projects.yaml +++ /dev/null @@ -1,31 +0,0 @@ -get: - summary: 按指定条件列出项目 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/scope' - - $ref: '../parameters/identity.yaml#/project_domain' - responses: - 200: - description: 项目列表信息 - schema: - $ref: "../schemas/project.yaml#/ProjectListResponse" - tags: - - projects - -post: - summary: 新建一个项目 - parameters: - - name: project - in: body - required: true - schema: - $ref: "../schemas/project.yaml#/ProjectCreateInput" - responses: - 200: - description: 项目信息 - schema: - $ref: "../schemas/project.yaml#/ProjectGetResponse" - tags: - - projects - diff --git a/docs/identity/projectuserrole.yaml b/docs/identity/projectuserrole.yaml deleted file mode 100644 index da7bf71e61..0000000000 --- a/docs/identity/projectuserrole.yaml +++ /dev/null @@ -1,25 +0,0 @@ -put: - deprecated: true - summary: 将用户以指定角色加入项目 - parameters: - - $ref: '../parameters/identity.yaml#/project_id' - - $ref: '../parameters/identity.yaml#/user_id' - - $ref: '../parameters/identity.yaml#/role_id' - responses: - 200: - description: 成功 - tags: - - roles - -delete: - deprecated: true - summary: 将用户在项目中的角色删除 - parameters: - - $ref: '../parameters/identity.yaml#/project_id' - - $ref: '../parameters/identity.yaml#/user_id' - - $ref: '../parameters/identity.yaml#/role_id' - responses: - 200: - description: 成功 - tags: - - roles diff --git a/docs/identity/region.yaml b/docs/identity/region.yaml deleted file mode 100644 index 37a8ee5133..0000000000 --- a/docs/identity/region.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定区域的详情 - parameters: - - $ref: '../parameters/region.yaml#/region_id' - responses: - 200: - description: 区域信息 - schema: - $ref: "../schemas/region.yaml#/RegionGetResponse" - tags: - - regions - -put: - summary: 更新指定区域的属性 - parameters: - - $ref: '../parameters/region.yaml#/region_id' - - name: region - in: body - required: true - schema: - $ref: "../schemas/region.yaml#/RegionPutRequestInput" - responses: - 200: - description: 区域信息 - schema: - $ref: "../schemas/region.yaml#/RegionGetResponse" - tags: - - regions - -delete: - summary: 删除指定区域 - parameters: - - $ref: '../parameters/region.yaml#/region_id' - responses: - 200: - description: 被删除的区域信息 - schema: - $ref: "../schemas/region.yaml#/RegionGetResponse" - tags: - - regions diff --git a/docs/identity/regions.yaml b/docs/identity/regions.yaml deleted file mode 100644 index 9a1ab71878..0000000000 --- a/docs/identity/regions.yaml +++ /dev/null @@ -1,28 +0,0 @@ -get: - summary: 按指定条件列出区域 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - responses: - 200: - description: 区域列表信息 - schema: - $ref: "../schemas/region.yaml#/RegionListResponse" - tags: - - regions - -post: - summary: 新建一个区域 - parameters: - - name: region - in: body - required: true - schema: - $ref: "../schemas/region.yaml#/RegionCreateInput" - responses: - 200: - description: 区域信息 - schema: - $ref: "../schemas/region.yaml#/RegionGetResponse" - tags: - - regions diff --git a/docs/identity/role.yaml b/docs/identity/role.yaml deleted file mode 100644 index bf79b760c7..0000000000 --- a/docs/identity/role.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定角色的详情 - parameters: - - $ref: '../parameters/role.yaml#/role_id' - responses: - 200: - description: 角色信息 - schema: - $ref: "../schemas/role.yaml#/RoleGetResponse" - tags: - - roles - -put: - summary: 更新指定角色的属性 - parameters: - - $ref: '../parameters/role.yaml#/role_id' - - name: role - in: body - required: true - schema: - $ref: "../schemas/role.yaml#/RolePutRequestInput" - responses: - 200: - description: 角色信息 - schema: - $ref: "../schemas/role.yaml#/RoleGetResponse" - tags: - - roles - -delete: - summary: 删除指定角色 - parameters: - - $ref: '../parameters/role.yaml#/role_id' - responses: - 200: - description: 被删除的角色信息 - schema: - $ref: "../schemas/role.yaml#/RoleGetResponse" - tags: - - roles diff --git a/docs/identity/roleassignments.yaml b/docs/identity/roleassignments.yaml deleted file mode 100644 index 33a36fe260..0000000000 --- a/docs/identity/roleassignments.yaml +++ /dev/null @@ -1,19 +0,0 @@ -get: - summary: 按指定条件列出用户或者组加入项目的信息 - parameters: - - $ref: '../parameters/roleassignments.yaml#/user.id' - - $ref: '../parameters/roleassignments.yaml#/group.id' - - $ref: '../parameters/roleassignments.yaml#/role.id' - - $ref: '../parameters/roleassignments.yaml#/scope.domain.id' - - $ref: '../parameters/roleassignments.yaml#/scope.project.id' - - $ref: '../parameters/roleassignments.yaml#/include_names' - - $ref: '../parameters/roleassignments.yaml#/effective' - - $ref: '../parameters/roleassignments.yaml#/include_system' - - $ref: '../parameters/roleassignments.yaml#/include_policies' - responses: - 200: - description: 用户或组加入项目的信息列表 - schema: - $ref: "../schemas/roleassignments.yaml#/RoleAssignmentListResponse" - tags: - - role_assignments diff --git a/docs/identity/roles.yaml b/docs/identity/roles.yaml deleted file mode 100644 index d597f0a670..0000000000 --- a/docs/identity/roles.yaml +++ /dev/null @@ -1,30 +0,0 @@ -get: - summary: 按指定条件列出角色 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/scope' - - $ref: '../parameters/identity.yaml#/project_domain' - responses: - 200: - description: 角色列表信息 - schema: - $ref: "../schemas/role.yaml#/RoleListResponse" - tags: - - roles - -post: - summary: 新建一个角色 - parameters: - - name: role - in: body - required: true - schema: - $ref: "../schemas/role.yaml#/RoleCreateInput" - responses: - 200: - description: 角色信息 - schema: - $ref: "../schemas/role.yaml#/RoleGetResponse" - tags: - - roles diff --git a/docs/identity/service.yaml b/docs/identity/service.yaml deleted file mode 100644 index 11c4c35d98..0000000000 --- a/docs/identity/service.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定服务的详情 - parameters: - - $ref: '../parameters/service.yaml#/service_id' - responses: - 200: - description: 服务信息 - schema: - $ref: "../schemas/service.yaml#/ServiceGetResponse" - tags: - - services - -put: - summary: 更新指定服务的属性 - parameters: - - $ref: '../parameters/service.yaml#/service_id' - - name: service - in: body - required: true - schema: - $ref: "../schemas/service.yaml#/ServicePutRequestInput" - responses: - 200: - description: 服务信息 - schema: - $ref: "../schemas/service.yaml#/ServiceGetResponse" - tags: - - services - -delete: - summary: 删除指定服务 - parameters: - - $ref: '../parameters/service.yaml#/service_id' - responses: - 200: - description: 被删除的服务信息 - schema: - $ref: "../schemas/service.yaml#/ServiceGetResponse" - tags: - - services diff --git a/docs/identity/services.yaml b/docs/identity/services.yaml deleted file mode 100644 index 5594577280..0000000000 --- a/docs/identity/services.yaml +++ /dev/null @@ -1,29 +0,0 @@ -get: - summary: 按指定条件列出服务 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/search' - responses: - 200: - description: 服务列表信息 - schema: - $ref: "../schemas/service.yaml#/ServiceListResponse" - tags: - - services - -post: - summary: 新建一个服务 - parameters: - - name: service - in: body - required: true - schema: - $ref: "../schemas/service.yaml#/ServiceCreateInput" - responses: - 200: - description: 服务信息 - schema: - $ref: "../schemas/service.yaml#/ServiceGetResponse" - tags: - - services diff --git a/docs/identity/user.yaml b/docs/identity/user.yaml deleted file mode 100644 index df43e9f572..0000000000 --- a/docs/identity/user.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获得指定用户的详情 - parameters: - - $ref: '../parameters/user.yaml#/user_id' - responses: - 200: - description: 用户信息 - schema: - $ref: "../schemas/user.yaml#/UserGetResponse" - tags: - - users - -put: - summary: 更新指定用户的信息 - parameters: - - $ref: '../parameters/user.yaml#/user_id' - - name: user - in: body - required: true - schema: - $ref: "../schemas/user.yaml#/UserPutRequestInput" - responses: - 200: - description: 用户信息 - schema: - $ref: "../schemas/user.yaml#/UserGetResponse" - tags: - - users - -delete: - summary: 删除指定的用户 - parameters: - - $ref: '../parameters/user.yaml#/user_id' - responses: - 200: - description: 被删除的用户信息 - schema: - $ref: "../schemas/user.yaml#/UserGetResponse" - tags: - - users diff --git a/docs/identity/user_join.yaml b/docs/identity/user_join.yaml deleted file mode 100644 index 7703625e6a..0000000000 --- a/docs/identity/user_join.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 将用户以多个角色加入多个项目 - parameters: - - $ref: '../parameters/user.yaml#/user_id' - - name: user - in: body - required: true - schema: - $ref: "../schemas/project.yaml#/ProjectJoinRequestInput" - responses: - 200: - description: 用户信息 - schema: - $ref: "../schemas/user.yaml#/UserGetResponse" - tags: - - users diff --git a/docs/identity/user_leave.yaml b/docs/identity/user_leave.yaml deleted file mode 100644 index a989ef8496..0000000000 --- a/docs/identity/user_leave.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 将用户的多个角色从多个项目中删除 - parameters: - - $ref: '../parameters/user.yaml#/user_id' - - name: user - in: body - required: true - schema: - $ref: "../schemas/project.yaml#/ProjectLeaveRequestInput" - responses: - 200: - description: 用户信息 - schema: - $ref: "../schemas/user.yaml#/UserGetResponse" - tags: - - users diff --git a/docs/identity/users.yaml b/docs/identity/users.yaml deleted file mode 100644 index 0c788e0577..0000000000 --- a/docs/identity/users.yaml +++ /dev/null @@ -1,32 +0,0 @@ -get: - summary: 按指定条件列出用户 - parameters: - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/scope' - - $ref: '../parameters/identity.yaml#/project_domain' - - $ref: '../parameters/user.yaml#/system' - responses: - 200: - description: 用户列表信息 - schema: - $ref: "../schemas/user.yaml#/UserListResponse" - tags: - - users - -post: - summary: 新建一个本地用户 - parameters: - - name: user - in: body - required: true - schema: - $ref: "../schemas/user.yaml#/UserCreateInput" - responses: - 200: - description: 用户信息 - schema: - $ref: "../schemas/user.yaml#/UserGetResponse" - tags: - - users - diff --git a/docs/identity/verify_v2.yaml b/docs/identity/verify_v2.yaml deleted file mode 100644 index 825f50550c..0000000000 --- a/docs/identity/verify_v2.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: keystone v2验证token API - parameters: - - $ref: '../parameters/auth.yaml#/token' - responses: - 200: - description: 角色列表信息 - schema: - $ref: "../schemas/auth.yaml#/Auth2Response" - tags: - - authentication diff --git a/docs/image/guest-image.yaml b/docs/image/guest-image.yaml deleted file mode 100644 index 9d0d0ee200..0000000000 --- a/docs/image/guest-image.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定主机镜像的详细信息 - parameters: - - $ref: "../parameters/image.yaml#/imageId" - responses: - 200: - description: 主机镜像详细信息 - schema: - $ref: "../schemas/guest_image.yaml#/GuestImageResponse" - tags: - - guestimage - -delete: - summary: 删除指定主机镜像 - parameters: - - $ref: "../parameters/image.yaml#/imageId" - responses: - 200: - schema: - $ref: "../schemas/guest_image.yaml#/GuestImageResponse" - tags: - - guestimage diff --git a/docs/image/guest-images.yaml b/docs/image/guest-images.yaml deleted file mode 100644 index 5470bef79c..0000000000 --- a/docs/image/guest-images.yaml +++ /dev/null @@ -1,13 +0,0 @@ -get: - summary: 按指定条件列出主机镜像 - parameters: - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/limit" - - responses: - 200: - description: 主机镜像列表信息 - schema: - $ref: "../schemas/guest_image.yaml#/GuestImageListResponse" - tags: - - guestimage diff --git a/docs/image/image-standard.yaml b/docs/image/image-standard.yaml deleted file mode 100644 index 143c471e80..0000000000 --- a/docs/image/image-standard.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - parameters: - - $ref: "../parameters/image.yaml#/imageId" - - in: body - name: image - required: true - schema: - $ref: "../schemas/image.yaml#/ImageMarkStandard" - summary: 设置/取消设置镜像为标准镜像 - responses: - 200: - description: 镜像信息 - schema: - $ref: "../schemas/image.yaml#/ImageResponse" - tags: - - images diff --git a/docs/image/image.yaml b/docs/image/image.yaml deleted file mode 100644 index fb6a247f3c..0000000000 --- a/docs/image/image.yaml +++ /dev/null @@ -1,220 +0,0 @@ -parameters: - - $ref: "../parameters/image.yaml#/imageId" - -head: - summary: 获取指定镜像详情信息 - responses: - 200: - description: 镜像信息 - headers: - x-image-meta-checksum: - type: string - #example: ef7a1c502ee2c9a288486f91d24330f0 - description: 镜像md5值 - x-image-meta-created_at: - type: string - #example: 2019-05-30T09:23:16.000000Z - description: 镜像创建时间 - x-image-meta-disk_format: - type: string - #example: qcow2 - description: 镜像格式 - x-image-meta-fast_hash: - type: string - #example: da6b40721d34676116d6ad8c446e7d29 - description: 待补充 - x-image-meta-id: - type: string - #example: b66e2776-5eca-4330-8706-f340415adf03 - description: 镜像ID - x-image-meta-is_public: - type: boolean - #example: true - description: 是否是标准镜像 - x-image-meta-min_disk: - type: integer - #example: 30720 - description: 磁盘最低大小 - x-image-meta-min_ram: - type: integer - #example: 0 - description: 内存最低要求 - x-image-meta-name: - type: string - #example: ubuntu-16.04.5-server-20181117.qcow2 - description: 镜像名称 - x-image-meta-owner: - type: string - #example: a7f2e2a81a1e4850a41eae5f140ceb14 - description: 所属用户 - x-image-meta-pending_deleted: - type: boolean - #example: true - description: 是否是在回收站 - x-image-meta-property-os_arch: - type: string - #example: x86 - description: 操作系统架构 - x-image-meta-property-os_distribution: - type: string - #example: Ubuntu - description: 操作系统发行版 - x-image-meta-property-os_type: - type: string - #example: Linux - description: 操作系统类型 - x-image-meta-property-os_version: - type: string - #example: 16.0 - description: 操作系统版本 - x-image-meta-protected: - type: boolean - #example: true - description: 镜像是否受保护 - x-image-meta-size: - type: integer - #example: 792592384 - description: 镜像大小 - x-image-meta-status: - type: string - #example: active - description: 镜像状态 - x-image-meta-tenant_id: - type: string - #example: true - description: 镜像所属项目ID - x-image-meta-updated_at: - type: string - #example: 2019-05-30T09:26:41.000000Z - description: 镜像最近一次更新时间 - x-image-meta-is_data: - type: boolean - description: 是否是数据盘镜像 - x-image-meta-is_guest_image: - type: boolean - description: 镜像是否是主机镜像的一部分 - tags: - - images - -put: - parameters: - - $ref: "../parameters/image.yaml#/x-image-meta-name" - - $ref: "../parameters/image.yaml#/x-image-meta-is_public" - - $ref: "../parameters/image.yaml#/x-image-meta-description" - - $ref: "../parameters/image.yaml#/x-image-meta-property-os_arch" - - $ref: "../parameters/image.yaml#/x-image-meta-property-os_distribution" - - $ref: "../parameters/image.yaml#/x-image-meta-property-os_version" - - in: body - type: file - description: 镜像二进制文件内容 - summary: 更新镜像信息或上传镜像文件 - responses: - 200: - description: 镜像信息 - - schema: - $ref: "../schemas/image.yaml#/ImageResponse" - tags: - - images - -get: - parameters: - - in: query - name: format - enum: [vhd,vmdk,qcow2] - type: string - description: 镜像下载格式 - - in: query - name: torrent - type: boolean - description: 下载torrent种子 - tags: - - images - - summary: 下载镜像 - responses: - 200: - description: 镜像信息 - schema: - type: file - headers: - x-image-meta-checksum: - type: string - #example: ef7a1c502ee2c9a288486f91d24330f0 - description: 镜像md5值 - x-image-meta-created_at: - type: string - #example: 2019-05-30T09:23:16.000000Z - description: 镜像创建时间 - x-image-meta-disk_format: - type: string - #example: qcow2 - description: 镜像格式 - x-image-meta-fast_hash: - type: string - #example: da6b40721d34676116d6ad8c446e7d29 - description: 待补充 - x-image-meta-id: - type: string - #example: b66e2776-5eca-4330-8706-f340415adf03 - description: 镜像ID - x-image-meta-is_public: - type: boolean - #example: true - description: 是否是标准镜像 - x-image-meta-min_disk: - type: integer - #example: 30720 - description: 磁盘最低大小 - x-image-meta-min_ram: - type: integer - #example: 0 - description: 内存最低要求 - x-image-meta-name: - type: string - #example: ubuntu-16.04.5-server-20181117.qcow2 - description: 镜像名称 - x-image-meta-owner: - type: string - #example: a7f2e2a81a1e4850a41eae5f140ceb14 - description: 所属用户 - x-image-meta-pending_deleted: - type: boolean - #example: true - description: 是否是在回收站 - x-image-meta-property-os_arch: - type: string - #example: x86 - description: 操作系统架构 - x-image-meta-property-os_distribution: - type: string - #example: Ubuntu - description: 操作系统发行版 - x-image-meta-property-os_type: - type: string - #example: Linux - description: 操作系统类型 - x-image-meta-property-os_version: - type: string - #example: 16.0 - description: 操作系统版本 - x-image-meta-protected: - type: boolean - #example: true - description: 镜像是否受保护 - x-image-meta-size: - type: integer - #example: 792592384 - description: 镜像大小 - x-image-meta-status: - type: string - #example: active - description: 镜像状态 - x-image-meta-tenant_id: - type: string - #example: true - description: 镜像所属项目ID - x-image-meta-updated_at: - type: string - #example: 2019-05-30T09:26:41.000000Z - description: 镜像最近一次更新时间 diff --git a/docs/image/images.yaml b/docs/image/images.yaml deleted file mode 100644 index 29ce2a76ba..0000000000 --- a/docs/image/images.yaml +++ /dev/null @@ -1,35 +0,0 @@ -get: - summary: 按指定条件列出镜像 - parameters: - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/pending_delete" - - $ref: "../parameters/image.yaml#/is_public" - - $ref: "../parameters/image.yaml#/owner" - - $ref: "../parameters/image.yaml#/name" - - $ref: "../parameters/image.yaml#/disk_format" - - $ref: "../parameters/image.yaml#/disk_formats" - responses: - 200: - description: 镜像列表信息 - schema: - $ref: "../schemas/image.yaml#/ImageListResponse" - tags: - - images - -post: - summary: 上传或创建镜像 - parameters: - - $ref: "../parameters/image.yaml#/content-type" - - $ref: "../parameters/image.yaml#/x-image-meta-name" - - $ref: "../parameters/image.yaml#/x-image-meta-description" - - in: body - type: file - description: 镜像二进制文件内容,若body为空,仅创建镜像数据库字段，可以通过put接口再次上传body内容 - responses: - 200: - description: 上传的镜像信息 - schema: - $ref: "../schemas/image.yaml#/ImageResponse" - tags: - - images diff --git a/docs/index.yaml b/docs/index.yaml deleted file mode 100644 index 9e3c20166a..0000000000 --- a/docs/index.yaml +++ /dev/null @@ -1,669 +0,0 @@ -swagger: "2.0" -info: - title: "OneCloud API" - version: "1.0" - termsOfService: "" - contact: - email: zhouyousong@yunion.cn - license: - name: "Apache 2.0" - url: "http://www.apache.org/licenses/LICENSE-2.0.html" - -host: "10.168.222.136:8889" -basePath: "/" - -schemes: - - https - - http -consumes: - - application/json -produces: - - application/json - -securityDefinitions: - keystone: - type: apiKey - in: header - name: X-Auth-Token -security: - - keystone: [] - -paths: - /v2.0/tokens: - $ref: "./identity/auth_v2.yaml" - /v2.0/tokens/{token}: - $ref: "./identity/verify_v2.yaml" - /v3/auth/tokens: - $ref: "./identity/auth_v3.yaml" - - /storages: - $ref: "./storage/storages.yaml" - /storages/{storageId}: - $ref: "./storage/storage.yaml" - /storages/{storageId}/enable: - $ref: "./storage/storage.yaml#/enable" - /storages/{storageId}/disable: - $ref: "./storage/storage.yaml#/disable" - /storages/{storageId}/online: - $ref: "./storage/storage.yaml#/online" - /storages/{storageId}/offline: - $ref: "./storage/storage.yaml#/offline" - - /storagecaches: - $ref: "./storagecache/storagecaches.yaml" - /storagecaches/{storagecacheId}: - $ref: "./storagecache/storagecache.yaml" - /storagecaches/{storagecacheId}/cache-image: - $ref: "./storagecache/cache-image.yaml" - - /disks: - $ref: "./disk/disks.yaml" - /disks/{diskId}: - $ref: "./disk/disk.yaml" - /disks/{diskId}/resize: - $ref: "./disk/resize.yaml" - /disks/{diskId}/save: - $ref: "./disk/save.yaml" - /disks/{diskId}/private: - $ref: "./disk/private.yaml" - /disks/{diskId}/public: - $ref: "./disk/public.yaml" - /disks/{diskId}/purge: - $ref: "./disk/purge.yaml" - /disks/{diskId}/reset: - $ref: "./disk/reset.yaml" - /disks/{diskId}/create-snapshot: - $ref: "./disk/create-snapshot.yaml" - - /hosts: - $ref: "./host/hosts.yaml" - /hosts/{hostId}: - $ref: "./host/host.yaml" - /hosts/{hostId}/ping: - $ref: "./host/ping.yaml" - /hosts/{hostId}/enable: - $ref: "./host/enable.yaml" - /hosts/{hostId}/disable: - $ref: "./host/disable.yaml" - /hosts/{hostId}/syncstatus: - $ref: "./host/syncstatus.yaml" - /hosts/{hostId}/prepare: - $ref: "./host/prepare.yaml" - /hosts/{hostId}/ipmi: - $ref: "./host/ipmi.yaml" - /hosts/{hostId}/convert-hypervisor: - $ref: "./host/convert-hypervisor.yaml" - /hosts/{hostId}/undo-convert: - $ref: "./host/undo-convert.yaml" - /hosts/{hostId}/maintenance: - $ref: "./host/maintenance.yaml" - /hosts/{hostId}/unmaintenance: - $ref: "./host/unmaintenance.yaml" - /hosts/{hostId}/stop: - $ref: "./host/stop.yaml" - /hosts/{hostId}/start: - $ref: "./host/start.yaml" - /hosts/{hostId}/reset: - $ref: "./host/reset.yaml" - # /hosts/{hostId}/add-netif: - # $ref: "./host/add-netif.yaml" - # /hosts/{hostId}/remove-netif: - # $ref: "./host/remove-netif.yaml" - # /hosts/{hostId}/enable-netif: - # $ref: "./host/enable-netif.yaml" - # /hosts/{hostId}/disable-netif: - # $ref: "./host/disable-netif.yaml" - # /hosts/{hostId}/remove-all-netifs: - # $ref: "./host/remove-all-netifs.yaml" - /hosts/{hostId}/undo-prepaid-recycle: - $ref: "./host/undo-prepaid-recycle.yaml" - /hosts/{hostId}/renew-prepaid-recycle: - $ref: "./host/renew-prepaid-recycle.yaml" - /hosts/{hostId}/spec: - $ref: "./host/spec.yaml" - - /hoststorages: - $ref: "./hoststorage/hoststorage.yaml" - /hosts/{hostId}/storages/{storageId}: - $ref: "./hoststorage/hoststorages.yaml" - - /networks: - $ref: "./network/networks.yaml" - /networks/{networkId}: - $ref: "./network/network.yaml" - /networks/{networkId}/private: - $ref: "./network/network.yaml#/private" - /networks/{networkId}/public: - $ref: "./network/network.yaml#/public" - /networks/{networkId}/split: - $ref: "./network/network.yaml#/split" - /networks/{networkId}/merge: - $ref: "./network/network.yaml#/merge" - /networks/{networkId}/reserve-ip: - $ref: "./network/network.yaml#/reserve-ip" - /networks/{networkId}/release-reserve-ip: - $ref: "./network/network.yaml#/release-reserve-ip" - /networks/{networkId}/networkinterface: - $ref: "./network/networkinterface.yaml" - - /servers: - $ref: "./instance/instances.yaml" - /servers/{instanceId}/add-secgroup: - $ref: "./instance/add-secgroup.yaml" - /servers/{instanceId}/assign-secgroup: - $ref: "./instance/assign-secgroup.yaml" - /servers/{instanceId}/associate-eip: - $ref: "./instance/associate-eip.yaml" - /servers/{instanceId}/attachdisk: - $ref: "./instance/attachdisk.yaml" - /servers/{instanceId}/attach-isolate-device: - $ref: "./instance/attach-isolate-device.yaml" - /servers/{instanceId}/attachnetwork: - $ref: "./instance/attachnetwork.yaml" - /servers/{instanceId}/cancel-delete: - $ref: "./instance/cancel-delete.yaml" - /servers/{instanceId}/change-bandwidth: - $ref: "./instance/change-bandwidth.yaml" - /servers/{instanceId}/change-config: - $ref: "./instance/change-config.yaml" - /servers/{instanceId}/change-ip-addr: - $ref: "./instance/change-ip-addr.yaml" - /servers/{instanceId}/create-backup: - $ref: "./instance/create-backup.yaml" - /servers/{instanceId}/createdisk: - $ref: "./instance/createdisk.yaml" - /servers/{instanceId}/create-eip: - $ref: "./instance/create-eip.yaml" - /servers/{instanceId}/del-extra-option: - $ref: "./instance/del-extra-option.yaml" - /servers/{instanceId}/delete-backup: - $ref: "./instance/delete-backup.yaml" - /servers/{instanceId}/deploy: - $ref: "./instance/deploy.yaml" - /servers/{instanceId}/detachdisk: - $ref: "./instance/detachdisk.yaml" - /servers/{instanceId}/detach-isolate-device: - $ref: "./instance/detach-isolate-device.yaml" - /servers/{instanceId}/detachnetwork: - $ref: "./instance/detachnetwork.yaml" - /servers/{instanceId}/dissociate-eip: - $ref: "./instance/dissociate-eip.yaml" - /servers/{instanceId}/ejectiso: - $ref: "./instance/ejectiso.yaml" - /servers/{instanceId}/insertiso: - $ref: "./instance/insertiso.yaml" - /servers/{instanceId}/live-migrate: - $ref: "./instance/live-migrate.yaml" - /servers/{instanceId}/migrate: - $ref: "./instance/migrate.yaml" - /servers/{instanceId}/monitor: - $ref: "./instance/monitor.yaml" - /servers/{instanceId}/purge: - $ref: "./instance/purge.yaml" - /servers/{instanceId}/rebuild-root: - $ref: "./instance/rebuild-root.yaml" - /servers/{instanceId}/renew: - $ref: "./instance/renew.yaml" - /servers/{instanceId}/reset: - $ref: "./instance/reset.yaml" - /servers/{instanceId}/restart: - $ref: "./instance/restart.yaml" - /servers/{instanceId}/revoke-secgroup: - $ref: "./instance/revoke-secgroup.yaml" - /servers/{instanceId}/save-image: - $ref: "./instance/save-image.yaml" - /servers/{instanceId}/save-guest-image: - $ref: "./instance/save-guest-image.yaml" - /servers/{instanceId}/send-keys: - $ref: "./instance/send-keys.yaml" - /servers/{instanceId}/set-extra-option: - $ref: "./instance/set-extra-option.yaml" - /servers/{instanceId}/set-secgroup: - $ref: "./instance/set-secgroup.yaml" - /servers/{instanceId}: - $ref: "./instance/instance.yaml" - /servers/{instanceId}/start: - $ref: "./instance/start.yaml" - /servers/{instanceId}/status: - $ref: "./instance/status.yaml" - /servers/{instanceId}/stop: - $ref: "./instance/stop.yaml" - /servers/{instanceId}/suspend: - $ref: "./instance/suspend.yaml" - /servers/{instanceId}/switch-to-backup: - $ref: "./instance/switch-to-backup.yaml" - /servers/{instanceId}/sync: - $ref: "./instance/sync.yaml" - /servers/{instanceId}/syncstatus: - $ref: "./instance/syncstatus.yaml" - /servers/{instanceId}/user-data: - $ref: "./instance/user-data.yaml" - /servers/{instanceId}/vnc: - $ref: "./instance/vnc.yaml" - /servers/{instanceId}/io-throttle: - $ref: "./instance/io-throttle.yaml" - /servers/{instanceId}/bind-groups: - $ref: "./instance/bind-groups.yaml" - /servers/{instanceId}/unbind-groups: - $ref: "./instance/unbind-groups.yaml" - - /images: - $ref: "./image/images.yaml" - /images/{imageId}: - $ref: "./image/image.yaml" - /images/{imageId}/mark-standard: - $ref: "./image/image-standard.yaml" - - /guestimages: - $ref: "./image/guest-images.yaml" - /guestimages/{imageId}: - $ref: "./image/guest-image.yaml" - - /instancegroups: - $ref: "./instancegroup/instancegroups.yaml" - /instancegroups/{instancegroupId}: - $ref: "./instancegroup/instancegroup.yaml" - /instancegroups/{instancegroupId}/bind-guests: - $ref: "./instancegroup/bind-guest.yaml" - /instancegroups/{instancegroupId}/unbind-guests: - $ref: "./instancegroup/unbind-guest.yaml" - - /natgateways: - $ref: "./natgateway/natgateways.yaml" - /natgateways/{natgatewayId}: - $ref: "./natgateway/natgateway.yaml" - /natgateways/{natgatewayId}/dnat-resources: - $ref: "./natgateway/dnat-resources.yaml" - /natgateways/{natgatewayId}/snat-resources: - $ref: "./natgateway/snat-resources.yaml" - /natdentries: - $ref: "./natgateway/dnatentries.yaml" - /natdentries/{dnatentryId}: - $ref: "./natgateway/dnatentry.yaml" - /natsentries: - $ref: "./natgateway/snatentries.yaml" - /natsentries/{snatentryId}: - $ref: "./natgateway/snatentry.yaml" - - /snapshotpolicies: - $ref: "./snapshotpolicy/snapshotpolicies.yaml" - /snapshotpolicies/{snapshotpolicyId}: - $ref: "./snapshotpolicy/snapshotpolicy.yaml" - /disks/{disk_id}/snapshotpolicies: - $ref: "./snapshotpolicy/snapshotpolicydisk.yaml" - /snapshotpolicies/{snapshotpolicy_id}/disks: - $ref: "./snapshotpolicy/snapshotpolicydisk2.yaml" - /disks/{disk_id}/snapshotpolicies/{snapshotpolicy_id}: - $ref: "./snapshotpolicy/snapshotpolicydisk3.yaml" - /snapshotpolicies/{snapshotpolicyId}/bind-disks: - $ref: "./snapshotpolicy/bind-disk.yaml" - /snapshotpolicies/{snapshotpolicyId}/unbind-disks: - $ref: "./snapshotpolicy/unbind-disk.yaml" - /snapshotpolicies/{snapshotpolicyId}/cache: - $ref: "./snapshotpolicy/cache.yaml" - - /loadbalancers: - $ref: "./loadbalancer/loadbalancers.yaml" - /loadbalancers/{loadbalancerId}: - $ref: "./loadbalancer/loadbalancer.yaml" - - /cached_loadbalancer_acls: - $ref: "./loadbalancer/loadbalancercachedacls.yaml" - /cached_loadbalancer_acls/{loadbalancercachedaclId}: - $ref: "./loadbalancer/loadbalancercachedacl.yaml" - - /cached_loadbalancercertificates: - $ref: "./loadbalancer/loadbalancercachedcertificates.yaml" - /cached_loadbalancercertificates/{loadbalancercachedcertificateId}: - $ref: "./loadbalancer/loadbalancercachedcertificate.yaml" - - /loadbalancerlisteners: - $ref: "./loadbalancer/loadbalancerlisteners.yaml" - /loadbalancerlisteners/{loadbalancerlistenerId}: - $ref: "./loadbalancer/loadbalancerlistener.yaml" - /loadbalancerlisteners/{loadbalancerlistenerId}/backend-status: - $ref: "./loadbalancer/loadbalancerlistener-backend-status.yaml" - - /loadbalancerlistenerrules: - $ref: "./loadbalancer/loadbalancerlistenerrules.yaml" - /loadbalancerlistenerrules/{loadbalancerlistenerruleId}: - $ref: "./loadbalancer/loadbalancerlistenerrule.yaml" - /loadbalancerlistenerrules/{loadbalancerlistenerruleId}/backend-status: - $ref: "./loadbalancer/loadbalancerlistenerrule-backend-status.yaml" - - /loadbalancerbackendgroups: - $ref: "./loadbalancer/loadbalancerbackendgroups.yaml" - /loadbalancerbackendgroups/{loadbalancerbackendgroupId}: - $ref: "./loadbalancer/loadbalancerbackendgroup.yaml" - - /loadbalancerbackends: - $ref: "./loadbalancer/loadbalancerbackends.yaml" - /loadbalancerbackends/{loadbalancerbackendId}: - $ref: "./loadbalancer/loadbalancerbackend.yaml" - - /loadbalancerclusters: - $ref: "./loadbalancer/loadbalancerclusters.yaml" - /loadbalancerclusters/{loadbalancerClusterId}: - $ref: "./loadbalancer/loadbalancercluster.yaml" - - /loadbalanceragents: - $ref: "./loadbalancer/loadbalanceragents.yaml" - /loadbalanceragents/{loadbalancerAgentId}: - $ref: "./loadbalancer/loadbalanceragent.yaml" - /loadbalanceragents/{loadbalancerAgentId}/params-patch: - $ref: "./loadbalancer/loadbalanceragent-params-patch.yaml" - /loadbalanceragents/{loadbalancerAgentId}/deploy: - $ref: "./loadbalancer/loadbalanceragent-deploy.yaml" - /loadbalanceragents/{loadbalancerAgentId}/undeploy: - $ref: "./loadbalancer/loadbalanceragent-undeploy.yaml" - - /identity_providers: - $ref: "./identity/identity_providers.yaml" - /identity_providers/{idp_id}: - $ref: "./identity/identity_provider.yaml" - - /domains: - $ref: "./identity/domains.yaml" - /domains/{domain_id}: - $ref: "./identity/domain.yaml" - - /users: - $ref: "./identity/users.yaml" - /users/{user_id}: - $ref: "./identity/user.yaml" - /users/{user_id}/join: - $ref: "./identity/user_join.yaml" - /users/{user_id}/leave: - $ref: "./identity/user_leave.yaml" - - /groups: - $ref: "./identity/groups.yaml" - /groups/{group_id}: - $ref: "./identity/group.yaml" - /groups/{group_id}/join: - $ref: "./identity/group_join.yaml" - /groups/{group_id}/leave: - $ref: "./identity/group_leave.yaml" - /groups/{group_id}/users/{user_id}: - $ref: "./identity/groupuser.yaml" - - /projects: - $ref: "./identity/projects.yaml" - /projects/{project_id}: - $ref: "./identity/project.yaml" - /projects/{project_id}/join: - $ref: "./identity/project_join.yaml" - /projects/{project_id}/leave: - $ref: "./identity/project_leave.yaml" - - /roles: - $ref: "./identity/roles.yaml" - /roles/{role_id}: - $ref: "./identity/role.yaml" - /projects/{project_id}/users/{user_id}/roles/{role_id}: - $ref: "./identity/projectuserrole.yaml" - /projects/{project_id}/groups/{group_id}/roles/{role_id}: - $ref: "./identity/projectgrouprole.yaml" - - /policies: - $ref: "./identity/policies.yaml" - /policies/{policy_id}: - $ref: "./identity/policy.yaml" - - /credentials: - $ref: "./identity/credentials.yaml" - - /role_assignments: - $ref: "./identity/roleassignments.yaml" - - /regions: - $ref: "./identity/regions.yaml" - /regions/{region_id}: - $ref: "./identity/region.yaml" - - /services: - $ref: "./identity/services.yaml" - /services/{service_id}: - $ref: "./identity/service.yaml" - - /endpoints: - $ref: "./identity/endpoints.yaml" - /endpoints/{endpoint_id}: - $ref: "./identity/endpoint.yaml" - - /quotas: - $ref: "./quotas/quotas.yaml" - /quotas/{project_id}: - $ref: "./quotas/projectquotas.yaml" - /quotas/projects/{project_id}: - $ref: "./quotas/projectquotas.yaml" - /quotas/domains/{domain_id}: - $ref: "./quotas/domainquotas.yaml" - /quotas/projects: - $ref: "./quotas/projectquotalist.yaml" - /quotas/domains: - $ref: "./quotas/quotalist.yaml" - - /serverskus: - $ref: "./serversku/serverskus.yaml" - /serverskus/{serverskuId}: - $ref: "./serversku/serversku.yaml" - /serverskus/{serverskuId}/enable: - $ref: "./serversku/enable.yaml" - /serverskus/{serverskuId}/disable: - $ref: "./serversku/disable.yaml" - /serverskus/{serverskuId}/cache-sku: - $ref: "./serversku/cache-sku.yaml" - - /secgroups: - $ref: "./secgroup/secgroups.yaml" - /secgroups/{secgroupId}: - $ref: "./secgroup/secgroup.yaml" - /secgroups/{secgroupId}/clone: - $ref: "./secgroup/clone.yaml" - /secgroups/{secgroupId}/union: - $ref: "./secgroup/union.yaml" - /secgroups/{secgroupId}/add-rule: - $ref: "./secgroup/add-rule.yaml" - /secgroups/{secgroupId}/public: - $ref: "./secgroup/public.yaml" - /secgroups/{secgroupId}/private: - $ref: "./secgroup/private.yaml" - /secgroups/{secgroupId}/cache-secgroup: - $ref: "./secgroup/cache-secgroup.yaml" - /secgroups/{secgroupId}/uncache-secgroup: - $ref: "./secgroup/uncache-secgroup.yaml" - - - /secgroupcaches: - $ref: "./secgroupcache/secgroupcaches.yaml" - /secgroupcaches/{cacheId}: - $ref: "./secgroupcache/secgroupcache.yaml" - - - /secgrouprules: - $ref: "./secgrouprule/secgrouprules.yaml" - /secgrouprules/{secgroupruleId}: - $ref: "./secgrouprule/secgrouprule.yaml" - - /keypairs: - $ref: "./keypair/keypairs.yaml" - /keypairs/{keypairId}: - $ref: "./keypair/keypair.yaml" - - /elasticips: - $ref: "./elasticip/elasticips.yaml" - /elasticips/{elasticipId}: - $ref: "./elasticip/elasticip.yaml" - /elasticips/{elasticipId}/associate: - $ref: "./elasticip/associate.yaml" - /elasticips/{elasticipId}/dissociate: - $ref: "./elasticip/dissociate.yaml" - /elasticips/{elasticipId}/change-bandwidth: - $ref: "./elasticip/change-bandwidth.yaml" - /elasticips/{elasticipId}/purge: - $ref: "./elasticip/purge.yaml" - /elasticips/{elasticipId}/sync: - $ref: "./elasticip/sync.yaml" - - /networkinterfaces: - $ref: "./networkinterface/networkinterfaces.yaml" - /networkinterfaces/{networkinterfaceId}: - $ref: "./networkinterface/networkinterface.yaml" - /networkinterfaces/{networkinterfaceId}/networks: - $ref: "./networkinterface/networks.yaml" - - /buckets: - $ref: "./bucket/buckets.yaml" - /buckets/{bucketName}: - $ref: "./bucket/bucket.yaml" - /buckets/{bucketName}/objects: - $ref: "./bucket/listobjects.yaml" - /buckets/{bucketName}/delete: - $ref: "./bucket/deleteobjects.yaml" - /buckets/{bucketName}/makedir: - $ref: "./bucket/makedir.yaml" - /buckets/{bucketName}/upload: - $ref: "./bucket/uploadobject.yaml" - /buckets/{bucketName}/temp-url: - $ref: "./bucket/tempurl.yaml" - /buckets/{bucketName}/acl: - $ref: "./bucket/acl.yaml" - /buckets/{bucketName}/limit: - $ref: "./bucket/limit.yaml" - /buckets/{bucketName}/access-info: - $ref: "./bucket/access.yaml" - - /ansibleplaybooks: - $ref: "./ansibleplaybook/ansibleplaybooks.yaml" - /ansibleplaybooks/{ansibleplaybookId}: - $ref: "./ansibleplaybook/ansibleplaybook.yaml" - /ansibleplaybooks/{ansibleplaybookId}/run: - $ref: "./ansibleplaybook/ansibleplaybook-run.yaml" - /ansibleplaybooks/{ansibleplaybookId}/stop: - $ref: "./ansibleplaybook/ansibleplaybook-stop.yaml" - /dbinstances: - $ref: "./dbinstance/dbinstances.yaml" - /dbinstances/{dbinstanceId}: - $ref: "./dbinstance/dbinstance.yaml" - /dbinstances/{dbinstanceId}/networks: - $ref: "./dbinstance/dbinstancenetwork.yaml" - /dbinstances/{dbinstanceId}/reboot: - $ref: "./dbinstance/reboot.yaml" - /dbinstances/{dbinstanceId}/sync-status: - $ref: "./dbinstance/sync-status.yaml" - /dbinstances/{dbinstanceId}/purge: - $ref: "./dbinstance/purge.yaml" - /dbinstances/{dbinstanceId}/change-config: - $ref: "./dbinstance/change-config.yaml" - /dbinstances/{dbinstanceId}/public-connection: - $ref: "./dbinstance/public-connection.yaml" - /dbinstances/{dbinstanceId}/recovery: - $ref: "./dbinstance/recovery.yaml" - - - - /dbinstance_skus: - $ref: "./dbinstance_sku/dbinstance_skus.yaml" - /dbinstance_skus/{skuId}: - $ref: "./dbinstance_sku/dbinstance_sku.yaml" - - - - /dbinstancenetworks: - $ref: "./dbinstance/dbinstancenetworks.yaml" - - /dbinstanceparameters: - $ref: "./dbinstance/dbinstanceparameters.yaml" - /dbinstanceparameters/{parameterId}: - $ref: "./dbinstance/dbinstanceparameter.yaml" - - /dbinstancedatabases: - $ref: "./dbinstancedatabase/databases.yaml" - /dbinstancedatabases/{databaseId}: - $ref: "./dbinstancedatabase/database.yaml" - - /dbinstancebackups: - $ref: "./dbinstancebackup/backups.yaml" - /dbinstancebackups/{backupId}: - $ref: "./dbinstancebackup/backup.yaml" - - /dbinstanceaccounts: - $ref: "./dbinstanceaccount/accounts.yaml" - /dbinstanceaccounts/{accountId}: - $ref: "./dbinstanceaccount/account.yaml" - /dbinstanceaccounts/{accountId}/reset-password: - $ref: "./dbinstanceaccount/reset-password.yaml" - /dbinstanceaccounts/{accountId}/grant-privilege: - $ref: "./dbinstanceaccount/grant-privilege.yaml" - /dbinstanceaccounts/{accountId}/revoke-privilege: - $ref: "./dbinstanceaccount/revoke-privilege.yaml" - /dbinstanceaccounts/{accountId}/set-privileges: - $ref: "./dbinstanceaccount/set-privileges.yaml" - - - /elasticcaches: - $ref: "./elasticcache/elasticcaches.yaml" - /elasticcaches/{elasticcacheId}: - $ref: "./elasticcache/elasticcache.yaml" - /elasticcaches/{elasticcacheId}/allocate-public-connection: - $ref: "./elasticcache/allocate-public-connection.yaml" - /elasticcaches/{elasticcacheId}/release-public-connection: - $ref: "./elasticcache/release-public-connection.yaml" - /elasticcaches/{elasticcacheId}/change-spec: - $ref: "./elasticcache/change-spec.yaml" - /elasticcaches/{elasticcacheId}/login-info: - $ref: "./elasticcache/login-info.yaml" - /elasticcaches/{elasticcacheId}/flush-instance: - $ref: "./elasticcache/flush-instance.yaml" - /elasticcaches/{elasticcacheId}/restart: - $ref: "./elasticcache/restart.yaml" - /elasticcaches/{elasticcacheId}/set-maintain-time: - $ref: "./elasticcache/set-maintain-time.yaml" - /elasticcaches/{elasticcacheId}/update-auth-mode: - $ref: "./elasticcache/update-auth-mode.yaml" - /elasticcaches/{elasticcacheId}/update-backup-policy: - $ref: "./elasticcache/update-backup-policy.yaml" - /elasticcaches/{elasticcacheId}/update-instance-parameters: - $ref: "./elasticcache/update-instance-parameters.yaml" - /elasticcacheparameters: - $ref: "./elasticcache/elasticcacheparameters.yaml" - /elasticcacheparameters/{parameterId}: - $ref: "./elasticcache/elasticcacheparameter.yaml" - /elasticcacheacls: - $ref: "./elasticcache/elasticcacheacls.yaml" - /elasticcacheacls/{aclId}: - $ref: "./elasticcache/elasticcacheacl.yaml" - /elasticcachebackups: - $ref: "./elasticcache/elasticcachebackups.yaml" - /elasticcachebackups/{backupId}: - $ref: "./elasticcache/elasticcachebackup.yaml" - /elasticcachebackups/{backupId}/restore-instance: - $ref: "./elasticcache/restore-instance.yaml" - /elasticcacheaccounts: - $ref: "./elasticcache/elasticcacheaccounts.yaml" - /elasticcacheaccounts/{accountId}: - $ref: "./elasticcache/elasticcacheaccount.yaml" - /elasticcacheaccounts/{accountId}/reset-password: - $ref: "./elasticcache/reset-password.yaml" - /elasticcacheskus: - $ref: "./elasticcache/elasticcacheskus.yaml" - - /cloudaccounts: - $ref: "./cloudaccount/cloudaccounts.yaml" - /cloudaccounts/{cloudaccountId}: - $ref: "./cloudaccount/cloudaccount.yaml" - /cloudaccounts/{cloudaccountId}/change-project: - $ref: "./cloudaccount/change-project.yaml" - /cloudaccounts/{cloudaccountId}/disable: - $ref: "./cloudaccount/disable.yaml" - /cloudaccounts/{cloudaccountId}/enable: - $ref: "./cloudaccount/enable.yaml" - /cloudaccounts/{cloudaccountId}/sync: - $ref: "./cloudaccount/sync.yaml" - /cloudaccounts/{cloudaccountId}/update-credential: - $ref: "./cloudaccount/update-credential.yaml" - /cloudaccounts/{cloudaccountId}/enable-auto-sync: - $ref: "./cloudaccount/enable-auto-sync.yaml" - /cloudaccounts/{cloudaccountId}/disable-auto-sync: - $ref: "./cloudaccount/disable-auto-sync.yaml" diff --git a/docs/instance/add-secgroup.yaml b/docs/instance/add-secgroup.yaml deleted file mode 100644 index b14c40d0be..0000000000 --- a/docs/instance/add-secgroup.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 绑定安全组到实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceAddSecgroup' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/assign-secgroup.yaml b/docs/instance/assign-secgroup.yaml deleted file mode 100644 index f6cf10744c..0000000000 --- a/docs/instance/assign-secgroup.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 替换实例默认安全组 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceAssignSecgroup' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/associate-eip.yaml b/docs/instance/associate-eip.yaml deleted file mode 100644 index 8d7393979c..0000000000 --- a/docs/instance/associate-eip.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 实例关联弹性IP - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceAssociateEip' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/attach-isolate-device.yaml b/docs/instance/attach-isolate-device.yaml deleted file mode 100644 index be70e61119..0000000000 --- a/docs/instance/attach-isolate-device.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 透传设备 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceAttachIsolateDevice' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/attachdisk.yaml b/docs/instance/attachdisk.yaml deleted file mode 100644 index 81264a2756..0000000000 --- a/docs/instance/attachdisk.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 挂载磁盘到实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceAttachDisk' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/attachnetwork.yaml b/docs/instance/attachnetwork.yaml deleted file mode 100644 index 507a38a6be..0000000000 --- a/docs/instance/attachnetwork.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 实例绑定网络(从网络上分配IP地址) - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceAttachNetwork' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/bind-groups.yaml b/docs/instance/bind-groups.yaml deleted file mode 100644 index b7bd60bff0..0000000000 --- a/docs/instance/bind-groups.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 批量绑定主机组 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: groups - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceBindGroups' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance diff --git a/docs/instance/cancel-delete.yaml b/docs/instance/cancel-delete.yaml deleted file mode 100644 index f0a673212d..0000000000 --- a/docs/instance/cancel-delete.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 恢复回收站实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/change-bandwidth.yaml b/docs/instance/change-bandwidth.yaml deleted file mode 100644 index 7daeceb581..0000000000 --- a/docs/instance/change-bandwidth.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 更改实例网卡带宽 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceChangeBandwidth' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/change-config.yaml b/docs/instance/change-config.yaml deleted file mode 100644 index 388fccdf05..0000000000 --- a/docs/instance/change-config.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 更改实例配置 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceChangeConfig' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/change-ip-addr.yaml b/docs/instance/change-ip-addr.yaml deleted file mode 100644 index 240a9e6b8c..0000000000 --- a/docs/instance/change-ip-addr.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 更改实例IP地址 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceChangeIpAddr' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/create-backup.yaml b/docs/instance/create-backup.yaml deleted file mode 100644 index 79bea5c545..0000000000 --- a/docs/instance/create-backup.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 添加实例备份机 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/create-eip.yaml b/docs/instance/create-eip.yaml deleted file mode 100644 index 62f2519d6e..0000000000 --- a/docs/instance/create-eip.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 创建并绑定弹性IP给实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceCreateEip' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/createdisk.yaml b/docs/instance/createdisk.yaml deleted file mode 100644 index c42b6ad534..0000000000 --- a/docs/instance/createdisk.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 创建磁盘并挂载到实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceCreateDisk' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/del-extra-option.yaml b/docs/instance/del-extra-option.yaml deleted file mode 100644 index db340b4a70..0000000000 --- a/docs/instance/del-extra-option.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 删除实例额外选项 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceDelExtraOption' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/delete-backup.yaml b/docs/instance/delete-backup.yaml deleted file mode 100644 index 1735209f37..0000000000 --- a/docs/instance/delete-backup.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 删除实例备份机 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceDeleteBackup' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/deploy.yaml b/docs/instance/deploy.yaml deleted file mode 100644 index 8f332ab6f4..0000000000 --- a/docs/instance/deploy.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 重置实例密码信息 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceDeploy' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/detach-isolate-device.yaml b/docs/instance/detach-isolate-device.yaml deleted file mode 100644 index a4d133fcb0..0000000000 --- a/docs/instance/detach-isolate-device.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 解除透传设备 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceDetachIsolateDevice' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/detachdisk.yaml b/docs/instance/detachdisk.yaml deleted file mode 100644 index 10e8136429..0000000000 --- a/docs/instance/detachdisk.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 卸载实例磁盘 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceDetachDisk' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/detachnetwork.yaml b/docs/instance/detachnetwork.yaml deleted file mode 100644 index c12ad00a58..0000000000 --- a/docs/instance/detachnetwork.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 移除实例的网络(解绑网络上的IP地址) - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceDetachNetwork' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/dissociate-eip.yaml b/docs/instance/dissociate-eip.yaml deleted file mode 100644 index 9b2b6e7673..0000000000 --- a/docs/instance/dissociate-eip.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 解绑实例弹性IP - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceDissociateEip' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/ejectiso.yaml b/docs/instance/ejectiso.yaml deleted file mode 100644 index 281b6088d2..0000000000 --- a/docs/instance/ejectiso.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 卸载实例ISO设备 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/insertiso.yaml b/docs/instance/insertiso.yaml deleted file mode 100644 index a9534ad1f6..0000000000 --- a/docs/instance/insertiso.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 挂载ISO设备到实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceInsertIso' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/instance.yaml b/docs/instance/instance.yaml deleted file mode 100644 index b6b2aea742..0000000000 --- a/docs/instance/instance.yaml +++ /dev/null @@ -1,40 +0,0 @@ -get: - summary: 获取指定实例详情信息 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - $ref: '../parameters/common.yaml#/pending_delete' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance -put: - summary: 更新实例信息 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceUpdate' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance -delete: - summary: 删除指定实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - $ref: '../parameters/common.yaml#/override_pending_delete' - responses: - 200: - description: 被删除实例的信息,删除前确保已解除删除保护,第一次删除时会先进入回收站(可恢复),第二次删除会真正释放资源 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance diff --git a/docs/instance/instances.yaml b/docs/instance/instances.yaml deleted file mode 100644 index 4f9601410b..0000000000 --- a/docs/instance/instances.yaml +++ /dev/null @@ -1,49 +0,0 @@ -get: - summary: 按指定条件列出实例 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/account' - - $ref: '../parameters/common.yaml#/cloudprovider' - - $ref: '../parameters/common.yaml#/billing_type' - - $ref: '../parameters/common.yaml#/zone' - - $ref: '../parameters/common.yaml#/wire' - - $ref: '../parameters/common.yaml#/network' - - $ref: '../parameters/common.yaml#/vpc' - - $ref: '../parameters/common.yaml#/region' - - $ref: '../parameters/common.yaml#/pending_delete' - - $ref: '../parameters/instance.yaml#/host' - - $ref: '../parameters/instance.yaml#/with_eip' - - $ref: '../parameters/instance.yaml#/without_eip' - - $ref: '../parameters/instance.yaml#/gpu' - - $ref: '../parameters/instance.yaml#/order_by_disk' - - $ref: '../parameters/instance.yaml#/order_by_host' - - $ref: '../parameters/instance.yaml#/baremetal' - - $ref: '../parameters/instance.yaml#/hypervisor' - - $ref: '../parameters/instance.yaml#/secgroup' - - $ref: '../parameters/instance.yaml#/disk' - - $ref: '../parameters/instance.yaml#/usable_server_for_eip' - - $ref: '../parameters/instance.yaml#/group' - responses: - 200: - description: 实例列表信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceListResponse' - tags: - - instance -post: - summary: 创建实例 - parameters: - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceCreate' - responses: - 200: - description: 新创建的实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/io-throttle.yaml b/docs/instance/io-throttle.yaml deleted file mode 100644 index eb554c4b22..0000000000 --- a/docs/instance/io-throttle.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 虚拟机磁盘IO限速 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceIoThrottle' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/live-migrate.yaml b/docs/instance/live-migrate.yaml deleted file mode 100644 index c4275cab3a..0000000000 --- a/docs/instance/live-migrate.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 在线迁移实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceLiveMigrate' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/migrate.yaml b/docs/instance/migrate.yaml deleted file mode 100644 index 80c1ce59a0..0000000000 --- a/docs/instance/migrate.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 迁移实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceMigrate' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/monitor.yaml b/docs/instance/monitor.yaml deleted file mode 100644 index bbd9fbc597..0000000000 --- a/docs/instance/monitor.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 发送qemu-monitor指令给实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceMonitor' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/purge.yaml b/docs/instance/purge.yaml deleted file mode 100644 index 962321007b..0000000000 --- a/docs/instance/purge.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 抹除数据库实例数据(不真正删除实例) - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/rebuild-root.yaml b/docs/instance/rebuild-root.yaml deleted file mode 100644 index 1393643bb1..0000000000 --- a/docs/instance/rebuild-root.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 重装系统(更换系统镜像) - parameters: - - $ref: "../parameters/instance.yaml#/instanceId" - - in: body - name: server - required: true - schema: - $ref: "../schemas/instance.yaml#/InstanceRebuildRoot" - responses: - 200: - description: 实例信息 - schema: - $ref: "../schemas/instance.yaml#/InstanceResponse" - tags: - - instance diff --git a/docs/instance/renew.yaml b/docs/instance/renew.yaml deleted file mode 100644 index 2e0292c784..0000000000 --- a/docs/instance/renew.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 续费实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceRenew' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance diff --git a/docs/instance/reset.yaml b/docs/instance/reset.yaml deleted file mode 100644 index 73a8431d4c..0000000000 --- a/docs/instance/reset.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 重启实例(软重启) - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceReset' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/restart.yaml b/docs/instance/restart.yaml deleted file mode 100644 index cb9758fd37..0000000000 --- a/docs/instance/restart.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 重启实例(硬重启) - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceRestart' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/revoke-secgroup.yaml b/docs/instance/revoke-secgroup.yaml deleted file mode 100644 index b6b2930996..0000000000 --- a/docs/instance/revoke-secgroup.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 解绑实例安全组 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceRevokeSecgroup' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/save-guest-image.yaml b/docs/instance/save-guest-image.yaml deleted file mode 100644 index bef918f099..0000000000 --- a/docs/instance/save-guest-image.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 保存主机镜像 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceSaveImage' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance diff --git a/docs/instance/save-image.yaml b/docs/instance/save-image.yaml deleted file mode 100644 index 78ce76988c..0000000000 --- a/docs/instance/save-image.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 保存镜像 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceSaveImage' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/send-keys.yaml b/docs/instance/send-keys.yaml deleted file mode 100644 index 40998a8188..0000000000 --- a/docs/instance/send-keys.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 发送按键给实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceSendKeys' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/set-extra-option.yaml b/docs/instance/set-extra-option.yaml deleted file mode 100644 index 856887b7be..0000000000 --- a/docs/instance/set-extra-option.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 设置实例额外选项(USB透传) - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceSetExtraOption' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/set-secgroup.yaml b/docs/instance/set-secgroup.yaml deleted file mode 100644 index c9067e6dde..0000000000 --- a/docs/instance/set-secgroup.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 批量设置安全组 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceSetSecgroup' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/start.yaml b/docs/instance/start.yaml deleted file mode 100644 index 4f5ade66e8..0000000000 --- a/docs/instance/start.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 启动实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/status.yaml b/docs/instance/status.yaml deleted file mode 100644 index 716b83fe42..0000000000 --- a/docs/instance/status.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 更改实例状态 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceStatus' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/stop.yaml b/docs/instance/stop.yaml deleted file mode 100644 index 73543a6709..0000000000 --- a/docs/instance/stop.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 关闭实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceStop' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/suspend.yaml b/docs/instance/suspend.yaml deleted file mode 100644 index 6de396fb36..0000000000 --- a/docs/instance/suspend.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 休眠实例 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/switch-to-backup.yaml b/docs/instance/switch-to-backup.yaml deleted file mode 100644 index e7714bb485..0000000000 --- a/docs/instance/switch-to-backup.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 备份机转换 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/sync.yaml b/docs/instance/sync.yaml deleted file mode 100644 index 739a9f6a8a..0000000000 --- a/docs/instance/sync.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 同步配置信息 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/syncstatus.yaml b/docs/instance/syncstatus.yaml deleted file mode 100644 index 71c295e102..0000000000 --- a/docs/instance/syncstatus.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: 同步实例状态 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/unbind-groups.yaml b/docs/instance/unbind-groups.yaml deleted file mode 100644 index b83fb186f0..0000000000 --- a/docs/instance/unbind-groups.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 批量解绑主机组 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: groups - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceBindGroups' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance diff --git a/docs/instance/user-data.yaml b/docs/instance/user-data.yaml deleted file mode 100644 index bd23f48e06..0000000000 --- a/docs/instance/user-data.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 更新实例UserData - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - - in: body - name: server - required: true - schema: - $ref: '../schemas/instance.yaml#/InstanceUserData' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instance/vnc.yaml b/docs/instance/vnc.yaml deleted file mode 100644 index 762d95136e..0000000000 --- a/docs/instance/vnc.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取指定实例VNC信息 - parameters: - - $ref: '../parameters/instance.yaml#/instanceId' - responses: - 200: - description: 实例VNC信息 - schema: - $ref: '../schemas/instance.yaml#/InstanceVncResponse' - tags: - - instance \ No newline at end of file diff --git a/docs/instancegroup/bind-guest.yaml b/docs/instancegroup/bind-guest.yaml deleted file mode 100644 index 93117808f1..0000000000 --- a/docs/instancegroup/bind-guest.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 批量绑定主机 - parameters: - - $ref: '../parameters/instancegroup.yaml#/instancegroupId' - - in: body - name: guests - required: true - schema: - $ref: '../schemas/instancegroup.yaml#/InstanceGroupBindGuests' - responses: - 200: - description: 主机组 - schema: - $ref: '../schemas/instancegroup.yaml#/InstanceGroupResponse' - tags: - - instancegroup diff --git a/docs/instancegroup/instancegroup.yaml b/docs/instancegroup/instancegroup.yaml deleted file mode 100644 index d783617a9d..0000000000 --- a/docs/instancegroup/instancegroup.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定实例组的信息 - parameters: - - $ref: "../parameters/instancegroup.yaml#/instancegroupId" - responses: - 200: - description: 实例组的信息 - schema: - $ref: "../schemas/instancegroup.yaml#/InstanceGroupResponse" - tags: - - instancegroup - -delete: - summary: 删除指定的实例组 - parameters: - - $ref: '../parameters/instancegroup.yaml#/instancegroupId' - responses: - 200: - schema: - $ref: '../schemas/instancegroup.yaml#/InstanceGroupResponse' - tags: - - instancegroup diff --git a/docs/instancegroup/instancegroups.yaml b/docs/instancegroup/instancegroups.yaml deleted file mode 100644 index 8edfb09fec..0000000000 --- a/docs/instancegroup/instancegroups.yaml +++ /dev/null @@ -1,31 +0,0 @@ -get: - summary: 按指定条件列出主机组 - parameters: - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/instancegroup.yaml#/granularity" - - $ref: "../parameters/instancegroup.yaml#/guest" - - responses: - 200: - description: 实例组列表信息 - schema: - $ref: "../schemas/instancegroup.yaml#/InstanceGroupListResponse" - tags: - - instancegroup - -post: - summary: 创建主机组 - parameters: - - in: body - name: instancegroup - required: true - schema: - $ref: '../schemas/instancegroup.yaml#/InstanceGroupCreate' - responses: - 200: - description: 新建主机组的信息 - schema: - $ref: '../schemas/instancegroup.yaml#/InstanceGroupResponse' - tags: - - instancegroup diff --git a/docs/instancegroup/unbind-guest.yaml b/docs/instancegroup/unbind-guest.yaml deleted file mode 100644 index f166970d97..0000000000 --- a/docs/instancegroup/unbind-guest.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 批量解绑主机 - parameters: - - $ref: '../parameters/instancegroup.yaml#/instancegroupId' - - in: body - name: guests - required: true - schema: - $ref: '../schemas/instancegroup.yaml#/InstanceGroupBindGuests' - responses: - 200: - description: 主机组 - schema: - $ref: '../schemas/instancegroup.yaml#/InstanceGroupResponse' - tags: - - instancegroup diff --git a/docs/keypair/keypair.yaml b/docs/keypair/keypair.yaml deleted file mode 100644 index 0074def153..0000000000 --- a/docs/keypair/keypair.yaml +++ /dev/null @@ -1,39 +0,0 @@ -get: - summary: 获取指定秘钥详情信息 - parameters: - - $ref: "../parameters/keypair.yaml#/keypairId" - responses: - 200: - description: 秘钥详情信息 - schema: - $ref: "../schemas/keypair.yaml#/KeypairResponse" - tags: - - keypairs - -delete: - summary: 删除指定秘钥 - parameters: - - $ref: '../parameters/keypair.yaml#/keypairId' - responses: - 200: - schema: - $ref: '../schemas/keypair.yaml#/KeypairResponse' - tags: - - keypairs - -put: - summary: 更新秘钥信息 - parameters: - - $ref: '../parameters/keypair.yaml#/keypairId' - - in: body - name: keypair - required: true - schema: - $ref: '../schemas/keypair.yaml#/KeypairUpdate' - responses: - 200: - description: 秘钥信息 - schema: - $ref: '../schemas/keypair.yaml#/KeypairResponse' - tags: - - keypairs \ No newline at end of file diff --git a/docs/keypair/keypairs.yaml b/docs/keypair/keypairs.yaml deleted file mode 100644 index 8ce53807c1..0000000000 --- a/docs/keypair/keypairs.yaml +++ /dev/null @@ -1,29 +0,0 @@ -post: - summary: 创建秘钥 - parameters: - - in: body - name: keypair - required: true - schema: - $ref: '../schemas/keypair.yaml#/KeypairCreate' - responses: - 200: - description: 新建秘钥的信息 - schema: - $ref: '../schemas/keypair.yaml#/KeypairResponse' - tags: - - keypairs - -get: - summary: 按指定条件列出秘钥列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/keypair.yaml#/admin' - responses: - 200: - description: 秘钥列表信息 - schema: - $ref: '../schemas/keypair.yaml#/KeypairListResponse' - tags: - - keypairs diff --git a/docs/loadbalancer/loadbalancer.yaml b/docs/loadbalancer/loadbalancer.yaml deleted file mode 100644 index 628bcdf044..0000000000 --- a/docs/loadbalancer/loadbalancer.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定loadbalancer实例信息 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerId" - responses: - 200: - description: 实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerResponse" - tags: - - loadbalancers -delete: - summary: 删除指定loadbalancer实例 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerId" - responses: - 200: - description: 被删除实例的信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerResponse" - tags: - - loadbalancers diff --git a/docs/loadbalancer/loadbalanceragent-deploy.yaml b/docs/loadbalancer/loadbalanceragent-deploy.yaml deleted file mode 100644 index a3eda0404d..0000000000 --- a/docs/loadbalancer/loadbalanceragent-deploy.yaml +++ /dev/null @@ -1,32 +0,0 @@ -post: - summary: 部署和更新转发实例上的守护程序 - description: | - 部署前，需要先准备好keystone账号，用于lbagent程序访问api服务同步配置信息 - - keystone账号通过host.vars指定，描述如下 - - - `user`, 用户名 - - `pass`，密码 - - `proj`，项目名，一般情况下该值应当为`system` - - 当`deploy_method`为`yum`时，需要同时指定yum源相关的变量 - - - `repo_base_url`，一般情况下该值应当为`https://controller-host-ip/yumrepo` - - `repo_sslverify`，默认为0，表示访问仓库时不校验tls证书 - - 若`repo_base_url`使用https，且使用自签名证书时，一般应当关闭tls证书校验 - - 该操作依赖ansibleserver执行具体的部署任务。对应的ansibleplaybook任务id记录在deployment.ansibleplaybook，可通过这个ID获得部署执行的结果 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerAgentId" - - name: params - in: body - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentDeployRequest" - responses: - 200: - description: 变更后的转发实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse" - tags: - - loadbalanceragents diff --git a/docs/loadbalancer/loadbalanceragent-params-patch.yaml b/docs/loadbalancer/loadbalanceragent-params-patch.yaml deleted file mode 100644 index 1158129fa8..0000000000 --- a/docs/loadbalancer/loadbalanceragent-params-patch.yaml +++ /dev/null @@ -1,15 +0,0 @@ -post: - summary: 更改loadbalancer转发实例的守护进程的参数 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerAgentId" - - name: params - in: body - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentParams" - responses: - 200: - description: 变更后的转发实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse" - tags: - - loadbalanceragents diff --git a/docs/loadbalancer/loadbalanceragent-undeploy.yaml b/docs/loadbalancer/loadbalanceragent-undeploy.yaml deleted file mode 100644 index 7a1f53297a..0000000000 --- a/docs/loadbalancer/loadbalanceragent-undeploy.yaml +++ /dev/null @@ -1,18 +0,0 @@ -post: - summary: 下线转发实例 - description: | - 该操作要求被下线的转发实例之前通过lbagent-deploy部署 - - 下线的执行操作包括 - - - 卸载lbagent - - 停止正在运行的与转发相关的守护进程 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerAgentId" - responses: - 200: - description: 变更后的转发实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse" - tags: - - loadbalanceragents diff --git a/docs/loadbalancer/loadbalanceragent.yaml b/docs/loadbalancer/loadbalanceragent.yaml deleted file mode 100644 index 42b86fcb30..0000000000 --- a/docs/loadbalancer/loadbalanceragent.yaml +++ /dev/null @@ -1,46 +0,0 @@ -get: - summary: 获取指定loadbalancer转发实例信息 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerAgentId" - responses: - 200: - description: 转发实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse" - tags: - - loadbalanceragents -put: - summary: 更新loadbalancer转发实例自身参数 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerAgentId" - - name: loadbalanceragent - in: body - schema: - type: object - properties: - hb_timeout: - description: 转发实例心跳超时时间 - in: body - type: integer - minimum: 1 - example: 3600 - responses: - 200: - description: 转发实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse" - tags: - - loadbalanceragents -delete: - summary: 删除指定loadbalancer转发实例 - description: | - 删除操作仅涉及数据库记录，实际节点的下线计划需要管理员计划实施 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerId" - responses: - 200: - description: 被删除转发实例的信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse" - tags: - - loadbalanceragents diff --git a/docs/loadbalancer/loadbalanceragents.yaml b/docs/loadbalancer/loadbalanceragents.yaml deleted file mode 100644 index f884405834..0000000000 --- a/docs/loadbalancer/loadbalanceragents.yaml +++ /dev/null @@ -1,25 +0,0 @@ -get: - summary: 按指定条件列出loadbalancer转发实例 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/cluster" - responses: - 200: - description: 实例列表信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentListResponse" - tags: - - loadbalanceragents -post: - summary: 创建loadbalancer转发实例 - parameters: - - name: loadbalanceragent - in: body - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentCreateRequest" - responses: - 200: - description: 新创建的实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse" - tags: - - loadbalanceragents diff --git a/docs/loadbalancer/loadbalancerbackend.yaml b/docs/loadbalancer/loadbalancerbackend.yaml deleted file mode 100644 index f2ae79d0f5..0000000000 --- a/docs/loadbalancer/loadbalancerbackend.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定loadbalancer后端服务器信息 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerbackendId" - responses: - 200: - description: 实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendResponse" - tags: - - loadbalancerbackends -delete: - summary: 删除指定loadbalancer后端服务器 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerbackendId" - responses: - 200: - description: 被删除后端服务器的信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendResponse" - tags: - - loadbalancerbackends diff --git a/docs/loadbalancer/loadbalancerbackendgroup.yaml b/docs/loadbalancer/loadbalancerbackendgroup.yaml deleted file mode 100644 index 2506b5297a..0000000000 --- a/docs/loadbalancer/loadbalancerbackendgroup.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定loadbalancer后端服务器组信息 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerbackendgroupId" - responses: - 200: - description: 实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendGroupResponse" - tags: - - loadbalancerbackendgroups -delete: - summary: 删除指定loadbalancer后端服务器组实例 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerbackendgroupId" - responses: - 200: - description: 被删除后端服务器组的信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendGroupResponse" - tags: - - loadbalancerbackendgroups diff --git a/docs/loadbalancer/loadbalancerbackendgroups.yaml b/docs/loadbalancer/loadbalancerbackendgroups.yaml deleted file mode 100644 index 398d40206c..0000000000 --- a/docs/loadbalancer/loadbalancerbackendgroups.yaml +++ /dev/null @@ -1,26 +0,0 @@ -get: - summary: 按指定条件列出loadbalancer后端服务器组 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancer" - responses: - 200: - description: 后端服务器组列表 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendGroupListResponse" - tags: - - loadbalancerbackendgroups -post: - summary: 创建loadbalancer后端服务器组 - parameters: - - name: loadbalancer - in: body - schema: { type: string } - required: true - description: 指定loadbalaner实例uuid - responses: - 200: - description: 新创建的后端服务器组信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendGroupResponse" - tags: - - loadbalancerbackendgroups diff --git a/docs/loadbalancer/loadbalancerbackends.yaml b/docs/loadbalancer/loadbalancerbackends.yaml deleted file mode 100644 index cd3959746f..0000000000 --- a/docs/loadbalancer/loadbalancerbackends.yaml +++ /dev/null @@ -1,27 +0,0 @@ -get: - summary: 按指定条件列出loadbalancer后端服务器 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/backend_group" - - $ref: "../parameters/loadbalancer.yaml#/address" - - $ref: "../parameters/loadbalancer.yaml#/port" - responses: - 200: - description: 后端服务器组列表 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendListResponse" - tags: - - loadbalancerbackends -post: - summary: 创建loadbalancer后端服务器 - parameters: - - name: loadbalancerbackend - in: body - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendCreateRequest" - responses: - 200: - description: 新创建的后端服务器组信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerBackendResponse" - tags: - - loadbalancerbackends diff --git a/docs/loadbalancer/loadbalancercachedacl.yaml b/docs/loadbalancer/loadbalancercachedacl.yaml deleted file mode 100644 index c80cbdc5ea..0000000000 --- a/docs/loadbalancer/loadbalancercachedacl.yaml +++ /dev/null @@ -1,21 +0,0 @@ -parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancercachedaclId" - -get: - summary: 获取指定ACL缓存详情 - responses: - 200: - description: ACL信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedAclResponse" - tags: - - loadbalanceracls -delete: - summary: 删除指定ACL缓存 - responses: - 200: - description: 被删除ACL信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedAclResponse" - tags: - - loadbalanceracls \ No newline at end of file diff --git a/docs/loadbalancer/loadbalancercachedacls.yaml b/docs/loadbalancer/loadbalancercachedacls.yaml deleted file mode 100644 index b8ea3e6789..0000000000 --- a/docs/loadbalancer/loadbalancercachedacls.yaml +++ /dev/null @@ -1,25 +0,0 @@ -get: - summary: 按指定条件列出ACL缓存 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/acl_id" - responses: - 200: - description: ACL缓存列表 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedAclListResponse" - tags: - - loadbalanceracls -post: - summary: 同步ACL到指定公有云 - parameters: - - name: cachedloadbalanceracl - in: body - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedAclCreateRequest" - responses: - 200: - description: 新创建的公有云ACL - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedAclResponse" - tags: - - loadbalanceracls diff --git a/docs/loadbalancer/loadbalancercachedcertificate.yaml b/docs/loadbalancer/loadbalancercachedcertificate.yaml deleted file mode 100644 index 9d2ee5e952..0000000000 --- a/docs/loadbalancer/loadbalancercachedcertificate.yaml +++ /dev/null @@ -1,21 +0,0 @@ -parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancercachedcertificateId" - -get: - summary: 获取指定证书缓存详情 - responses: - 200: - description: 证书缓存信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedCertificateResponse" - tags: - - loadbalancercertificates -delete: - summary: 删除指定证书缓存 - responses: - 200: - description: 被删除证书缓存信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedCertificateResponse" - tags: - - loadbalancercertificates diff --git a/docs/loadbalancer/loadbalancercachedcertificates.yaml b/docs/loadbalancer/loadbalancercachedcertificates.yaml deleted file mode 100644 index 5edfd755dc..0000000000 --- a/docs/loadbalancer/loadbalancercachedcertificates.yaml +++ /dev/null @@ -1,25 +0,0 @@ -get: - summary: 按指定条件列出证书缓存 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/certificate_id" - responses: - 200: - description: 证书缓存列表 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedCertificateListResponse" - tags: - - loadbalancercertificates -post: - summary: 同步SSL证书到指定公有云 - parameters: - - name: cachedloadbalancercertificate - in: body - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedCertificateCreateRequest" - responses: - 200: - description: 新创建的公有云SSL证书 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedCertificateResponse" - tags: - - loadbalancercertificates diff --git a/docs/loadbalancer/loadbalancercluster.yaml b/docs/loadbalancer/loadbalancercluster.yaml deleted file mode 100644 index 066415fb2e..0000000000 --- a/docs/loadbalancer/loadbalancercluster.yaml +++ /dev/null @@ -1,26 +0,0 @@ -get: - summary: 获取指定loadbalancer集群信息 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerClusterId" - responses: - 200: - description: 集群信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerClusterResponse" - tags: - - loadbalancerclusters -delete: - summary: 删除指定loadbalancer集群 - description: | - 该操作会同时删除指定集群下的LoadbalancerAgent对象。 - - 该操作仅删除数据库记录，并不对实际的转发节点进行配置变更，转发节点的下线需要由管理员另外执行。 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerClusterId" - responses: - 200: - description: 被删除实例的信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerClusterResponse" - tags: - - loadbalancerclusters diff --git a/docs/loadbalancer/loadbalancerclusters.yaml b/docs/loadbalancer/loadbalancerclusters.yaml deleted file mode 100644 index 9eaaf273f3..0000000000 --- a/docs/loadbalancer/loadbalancerclusters.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 按指定条件列出loadbalancer集群 - responses: - 200: - description: Loadbalancer集群组列表 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerClusterListResponse" - tags: - - loadbalancerclusters -post: - summary: 创建loadbalancer集群 - parameters: - - name: loadbalancercluster - in: body - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerClusterCreateRequest" - responses: - 200: - description: 新创建的后端服务器组信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerClusterResponse" - tags: - - loadbalancerclusters diff --git a/docs/loadbalancer/loadbalancerlistener-backend-status.yaml b/docs/loadbalancer/loadbalancerlistener-backend-status.yaml deleted file mode 100644 index 1d44047d52..0000000000 --- a/docs/loadbalancer/loadbalancerlistener-backend-status.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取指定loadbalancer监听后端服务器的健康检查状态 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerlistenerId" - responses: - 200: - description: 后端状态列表 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerBackendStatusResponse" - tags: - - loadbalancerlisteners diff --git a/docs/loadbalancer/loadbalancerlistener.yaml b/docs/loadbalancer/loadbalancerlistener.yaml deleted file mode 100644 index 21239b66b7..0000000000 --- a/docs/loadbalancer/loadbalancerlistener.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定loadbalancer监听实例信息 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerlistenerId" - responses: - 200: - description: 实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerResponse" - tags: - - loadbalancerlisteners -delete: - summary: 删除指定loadbalancer监听实例 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerlistenerId" - responses: - 200: - description: 被删除实例的信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerResponse" - tags: - - loadbalancerlisteners diff --git a/docs/loadbalancer/loadbalancerlistenerrule-backend-status.yaml b/docs/loadbalancer/loadbalancerlistenerrule-backend-status.yaml deleted file mode 100644 index 3ca013da7e..0000000000 --- a/docs/loadbalancer/loadbalancerlistenerrule-backend-status.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取指定loadbalancer转发策略后端服务器的健康检查状态 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerlistenerruleId" - responses: - 200: - description: 后端状态列表 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerRuleBackendStatusResponse" - tags: - - loadbalancerlistenerrules diff --git a/docs/loadbalancer/loadbalancerlistenerrule.yaml b/docs/loadbalancer/loadbalancerlistenerrule.yaml deleted file mode 100644 index 9c281f3d4b..0000000000 --- a/docs/loadbalancer/loadbalancerlistenerrule.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定loadbalancer转发策略实例信息 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerlistenerruleId" - responses: - 200: - description: 实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerRuleResponse" - tags: - - loadbalancerlistenerrules -delete: - summary: 删除指定loadbalancer转发策略实例 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancerlistenerruleId" - responses: - 200: - description: 被删除实例的信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerRuleResponse" - tags: - - loadbalancerlistenerrules diff --git a/docs/loadbalancer/loadbalancerlistenerrules.yaml b/docs/loadbalancer/loadbalancerlistenerrules.yaml deleted file mode 100644 index 34ee9eaadf..0000000000 --- a/docs/loadbalancer/loadbalancerlistenerrules.yaml +++ /dev/null @@ -1,29 +0,0 @@ -get: - summary: 按指定条件列出loadbalancer转发规则实例 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/listener" - - $ref: "../parameters/loadbalancer.yaml#/backend_group" - - $ref: "../parameters/loadbalancer.yaml#/domain" - - $ref: "../parameters/loadbalancer.yaml#/path" - responses: - 200: - description: 转发规则实例信息列表 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerRuleListResponse" - tags: - - loadbalancerlistenerrules -post: - summary: 创建loadbalancer转发规则实例 - parameters: - - name: loadbalancerlistenerrule - in: body - required: true - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerRuleCreateRequest" - responses: - 200: - description: 新创建的实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerRuleResponse" - tags: - - loadbalancerlistenerrules diff --git a/docs/loadbalancer/loadbalancerlisteners.yaml b/docs/loadbalancer/loadbalancerlisteners.yaml deleted file mode 100644 index 1b60a21700..0000000000 --- a/docs/loadbalancer/loadbalancerlisteners.yaml +++ /dev/null @@ -1,28 +0,0 @@ -get: - summary: 按指定条件列出loadbalancer监听实例 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/loadbalancer" - - $ref: "../parameters/loadbalancer.yaml#/listener_type" - - $ref: "../parameters/loadbalancer.yaml#/listener_port" - responses: - 200: - description: 监听实例列表信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerListResponse" - tags: - - loadbalancerlisteners -post: - summary: 创建loadbalancer监听实例 - parameters: - - name: loadbalancerlistener - in: body - required: true - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerCreateRequest" - responses: - 200: - description: 新创建的实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListenerResponse" - tags: - - loadbalancerlisteners diff --git a/docs/loadbalancer/loadbalancers.yaml b/docs/loadbalancer/loadbalancers.yaml deleted file mode 100644 index 768281c1b3..0000000000 --- a/docs/loadbalancer/loadbalancers.yaml +++ /dev/null @@ -1,20 +0,0 @@ -get: - summary: 按指定条件列出loadbalancer实例 - parameters: - - $ref: "../parameters/loadbalancer.yaml#/address" - responses: - 200: - description: 实例列表信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerListResponse" - tags: - - loadbalancers -post: - summary: 创建loadbalancer实例 - responses: - 200: - description: 新创建的实例信息 - schema: - $ref: "../schemas/loadbalancer.yaml#/LoadbalancerResponse" - tags: - - loadbalancers diff --git a/docs/natgateway/dnat-resources.yaml b/docs/natgateway/dnat-resources.yaml deleted file mode 100644 index b8517f7ac1..0000000000 --- a/docs/natgateway/dnat-resources.yaml +++ /dev/null @@ -1,13 +0,0 @@ -post: - summary: NAT网关下DNAT规则EIP的集合 - parameters: - - $ref: "../parameters/natgateway.yaml#/natgatewayId" - responses: - 200: - description: DNAT规则EIP集合 - schema: - - $ref: "../schemas/natgateway.yaml#/DNATResources" - tags: - - natgateway - - diff --git a/docs/natgateway/dnatentries.yaml b/docs/natgateway/dnatentries.yaml deleted file mode 100644 index 4fd05941b9..0000000000 --- a/docs/natgateway/dnatentries.yaml +++ /dev/null @@ -1,32 +0,0 @@ -get: - summary: 按指定条件列出Nat网关DNat - parameters: - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/account" - - $ref: "../parameters/common.yaml#/brand" - - - $ref: "../parameters/natgateway.yaml#/natgateway" - responses: - 200: - description: Nat网关 DNat - schema: - $ref: "../schemas/natgateway.yaml#/DNatEntryListResponse" - tags: - - natdentry - -post: - summary: 创建DNat - parameters: - - in: body - name: dnatentry - required: true - schema: - $ref: '../schemas/natgateway.yaml#/DNatEntryCreate' - responses: - 200: - description: 新建DNat的信息 - schema: - $ref: '../schemas/natgateway.yaml#/DNatEntryResponse' - tags: - - natdentry diff --git a/docs/natgateway/dnatentry.yaml b/docs/natgateway/dnatentry.yaml deleted file mode 100644 index 4d2a619896..0000000000 --- a/docs/natgateway/dnatentry.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定DNat详情信息 - parameters: - - $ref: "../parameters/natgateway.yaml#/dnatentryId" - responses: - 200: - description: DNat信息 - schema: - $ref: "../schemas/natgateway.yaml#/DNatEntryResponse" - tags: - - natdentry - -delete: - summary: 删除指定DNat - parameters: - - $ref: '../parameters/natgateway.yaml#/dnatentryId' - responses: - 200: - schema: - $ref: '../schemas/natgateway.yaml#/DNatEntryResponse' - tags: - - natdentry diff --git a/docs/natgateway/natgateway.yaml b/docs/natgateway/natgateway.yaml deleted file mode 100644 index 038e666fa6..0000000000 --- a/docs/natgateway/natgateway.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取指定Nat详情信息 - parameters: - - $ref: "../parameters/natgateway.yaml#/natgatewayId" - responses: - 200: - description: Nat网关信息 - schema: - $ref: "../schemas/natgateway.yaml#/NatGatewayResponse" - tags: - - natgateway diff --git a/docs/natgateway/natgateways.yaml b/docs/natgateway/natgateways.yaml deleted file mode 100644 index 4c448149e5..0000000000 --- a/docs/natgateway/natgateways.yaml +++ /dev/null @@ -1,18 +0,0 @@ -get: - summary: 按指定条件列出Nat网关 - parameters: - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/cloudregion" - - $ref: "../parameters/common.yaml#/vpc" - - $ref: "../parameters/common.yaml#/provider" - - $ref: "../parameters/common.yaml#/account" - - $ref: "../parameters/common.yaml#/cloudprovider" - - $ref: "../parameters/common.yaml#/brand" - responses: - 200: - description: Nat网关列表信息 - schema: - $ref: "../schemas/natgateway.yaml#/NatGatewayListResponse" - tags: - - natgateway diff --git a/docs/natgateway/snat-resources.yaml b/docs/natgateway/snat-resources.yaml deleted file mode 100644 index a54041fab1..0000000000 --- a/docs/natgateway/snat-resources.yaml +++ /dev/null @@ -1,11 +0,0 @@ -post: - summary: NAT网关下SNAT规则EIP的集合 - parameters: - - $ref: "../parameters/natgateway.yaml#/natgatewayId" - responses: - 200: - description: SNAT规则EIP集合 - schema: - - $ref: "../schemas/natgateway.yaml#/SNATResources" - tags: - - natgateway diff --git a/docs/natgateway/snatentries.yaml b/docs/natgateway/snatentries.yaml deleted file mode 100644 index c143c82636..0000000000 --- a/docs/natgateway/snatentries.yaml +++ /dev/null @@ -1,33 +0,0 @@ -get: - summary: 按指定条件列出Nat网关SNat - parameters: - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/network" - - $ref: "../parameters/common.yaml#/account" - - $ref: "../parameters/common.yaml#/brand" - - $ref: "../parameters/natgateway.yaml#/natgateway" - - responses: - 200: - description: Nat网关 SNat - schema: - $ref: "../schemas/natgateway.yaml#/SNatEntryListResponse" - tags: - - natsentry - -post: - summary: 创建SNat - parameters: - - in: body - name: snatentry - required: true - schema: - $ref: '../schemas/natgateway.yaml#/SNatEntryCreate' - responses: - 200: - description: 新建SNat的信息 - schema: - $ref: '../schemas/natgateway.yaml#/SNatEntryResponse' - tags: - - natsentry diff --git a/docs/natgateway/snatentry.yaml b/docs/natgateway/snatentry.yaml deleted file mode 100644 index a76dc1ba1d..0000000000 --- a/docs/natgateway/snatentry.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定SNat详情信息 - parameters: - - $ref: "../parameters/natgateway.yaml#/snatentryId" - responses: - 200: - description: SNat信息 - schema: - $ref: "../schemas/natgateway.yaml#/SNatEntryResponse" - tags: - - natsentry - -delete: - summary: 删除指定SNat - parameters: - - $ref: '../parameters/natgateway.yaml#/snatentryId' - responses: - 200: - schema: - $ref: '../schemas/natgateway.yaml#/SNatEntryResponse' - tags: - - natsentry \ No newline at end of file diff --git a/docs/network/network.yaml b/docs/network/network.yaml deleted file mode 100644 index 80e3668821..0000000000 --- a/docs/network/network.yaml +++ /dev/null @@ -1,137 +0,0 @@ -get: - summary: 获取指定网络详情信息 - parameters: - - $ref: '../parameters/network.yaml#/networkId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -delete: - summary: 删除指定网络 - parameters: - - $ref: '../parameters/network.yaml#/networkId' - responses: - 200: - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -put: - summary: 更新IP子网信息 - parameters: - - $ref: '../parameters/network.yaml#/networkId' - - in: body - name: network - required: true - schema: - $ref: '../schemas/network.yaml#/NetworkUpdate' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -private: - post: - summary: 设置IP子网为私有 - parameters: - - $ref: '../parameters/network.yaml#/networkId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -public: - post: - summary: 设置IP子网为共享 - parameters: - - $ref: '../parameters/network.yaml#/networkId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -split: - post: - summary: 分割IP子网 - parameters: - - $ref: '../parameters/network.yaml#/networkId' - - in: body - name: network - required: true - schema: - $ref: '../schemas/network.yaml#/NetworkSplit' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -merge: - post: - summary: 分割IP子网 - parameters: - - $ref: '../parameters/network.yaml#/networkId' - - in: body - name: network - required: true - schema: - $ref: '../schemas/network.yaml#/NetworkMerge' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -reserve-ip: - post: - summary: 预留IP - parameters: - - $ref: '../parameters/network.yaml#/networkId' - - in: body - name: network - required: true - schema: - $ref: '../schemas/network.yaml#/NetworkReserveIp' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -release-reserve-ip: - post: - summary: 释放预留IP - parameters: - - $ref: '../parameters/network.yaml#/networkId' - - in: body - name: network - required: true - schema: - $ref: '../schemas/network.yaml#/NetworkReleaseReserveIp' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks \ No newline at end of file diff --git a/docs/network/networkinterface.yaml b/docs/network/networkinterface.yaml deleted file mode 100644 index efca25ed3a..0000000000 --- a/docs/network/networkinterface.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取指定子网下弹性网卡IP列表信息 - parameters: - - $ref: "../parameters/network.yaml#/networkId" - responses: - 200: - description: 弹性网卡IP列表信息 - schema: - $ref: "../schemas/networkinterfacenetwork.yaml#/NetworkinterfaceNetworkListResponse" - tags: - - networks \ No newline at end of file diff --git a/docs/network/networks.yaml b/docs/network/networks.yaml deleted file mode 100644 index 17db3cf86b..0000000000 --- a/docs/network/networks.yaml +++ /dev/null @@ -1,38 +0,0 @@ -post: - summary: 创建IP子网 - parameters: - - in: body - name: network - required: true - schema: - $ref: '../schemas/network.yaml#/NetworkCreate' - responses: - 200: - description: 新建IP子网的信息 - schema: - $ref: '../schemas/network.yaml#/NetworkResponse' - tags: - - networks - -get: - summary: 按指定条件列出IP子网 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/zone' - - $ref: '../parameters/common.yaml#/region' - - $ref: '../parameters/common.yaml#/brand' - - $ref: '../parameters/common.yaml#/city' - - $ref: '../parameters/network.yaml#/ip' - - $ref: '../parameters/network.yaml#/zone' - - $ref: '../parameters/network.yaml#/wire' - - $ref: '../parameters/network.yaml#/vpc' - - $ref: '../parameters/network.yaml#/region' - - $ref: '../parameters/network.yaml#/server_type' - responses: - 200: - description: IP子网列表信息 - schema: - $ref: '../schemas/network.yaml#/NetworkListResponse' - tags: - - networks diff --git a/docs/networkinterface/networkinterface.yaml b/docs/networkinterface/networkinterface.yaml deleted file mode 100644 index 14410789f5..0000000000 --- a/docs/networkinterface/networkinterface.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定弹性网卡详情信息 - parameters: - - $ref: "../parameters/networkinterface.yaml#/networkinterfaceId" - responses: - 200: - description: 弹性网卡详情信息 - schema: - $ref: "../schemas/networkinterface.yaml#/NetworkinterfaceResponse" - tags: - - networkinterfaces - -delete: - summary: 删除指定弹性网卡 - parameters: - - $ref: "../parameters/networkinterface.yaml#/networkinterfaceId" - responses: - 200: - description: 被删除弹性网卡的信息 - schema: - $ref: "../schemas/networkinterface.yaml#/NetworkinterfaceResponse" - tags: - - networkinterfaces \ No newline at end of file diff --git a/docs/networkinterface/networkinterfaces.yaml b/docs/networkinterface/networkinterfaces.yaml deleted file mode 100644 index 445844aedf..0000000000 --- a/docs/networkinterface/networkinterfaces.yaml +++ /dev/null @@ -1,14 +0,0 @@ -get: - summary: 按指定条件列出弹性网卡列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/cloudregion' - - $ref: '../parameters/common.yaml#/zone' - responses: - 200: - description: 弹性网卡列表信息 - schema: - $ref: "../schemas/networkinterface.yaml#/NetworkinterfaceListResponse" - tags: - - networkinterfaces \ No newline at end of file diff --git a/docs/networkinterface/networks.yaml b/docs/networkinterface/networks.yaml deleted file mode 100644 index a441c3733e..0000000000 --- a/docs/networkinterface/networks.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取指定弹性网卡底下的IP列表 - parameters: - - $ref: "../parameters/networkinterface.yaml#/networkinterfaceId" - responses: - 200: - description: 弹性网卡IP列表信息 - schema: - $ref: "../schemas/networkinterfacenetwork.yaml#/NetworkinterfaceNetworkListResponse" - tags: - - networkinterfaces \ No newline at end of file diff --git a/docs/networkinterfacenetwork/networkinterfacenetworks.yaml b/docs/networkinterfacenetwork/networkinterfacenetworks.yaml deleted file mode 100644 index 7ba65e5a95..0000000000 --- a/docs/networkinterfacenetwork/networkinterfacenetworks.yaml +++ /dev/null @@ -1,12 +0,0 @@ -get: - summary: 按指定条件列出弹性网卡IP列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - responses: - 200: - description: 弹性网卡IP列表信息 - schema: - $ref: "../schemas/networkinterfacenetwork.yaml#/NetworkinterfaceNetworkListResponse" - tags: - - networkinterfaces \ No newline at end of file diff --git a/docs/parameters/ansibleplaybook.yaml b/docs/parameters/ansibleplaybook.yaml deleted file mode 100644 index 29038dce21..0000000000 --- a/docs/parameters/ansibleplaybook.yaml +++ /dev/null @@ -1,5 +0,0 @@ -ansibleplaybookId: - name: ansibleplaybookId - type: string - in: path - required: true diff --git a/docs/parameters/auth.yaml b/docs/parameters/auth.yaml deleted file mode 100644 index dfc44e23ca..0000000000 --- a/docs/parameters/auth.yaml +++ /dev/null @@ -1,14 +0,0 @@ -token: - name: token - type: string - in: path - required: true - description: keystone v2 token to be verified - -token3: - name: X-Subject-Token - in: header - schema: - type: string - required: true - description: keystone v3 token to be verified diff --git a/docs/parameters/bucket.yaml b/docs/parameters/bucket.yaml deleted file mode 100644 index e7654fe77e..0000000000 --- a/docs/parameters/bucket.yaml +++ /dev/null @@ -1,48 +0,0 @@ -bucket_name: - name: bucket_name - type: string - required: true - in: path - description: 存储桶的名称 - -prefix: - name: prefix - type: string - in: query - description: 对象的前缀过滤 - -recursive: - name: recursive - type: bool - in: query - description: 是否展开对象列表，false则只显示当前目录层级下的对象，true则显示匹配前缀的所有对象 - -x-bucket-object-key: - name: X-Yunion-Bucket-Upload-Key - type: string - in: header - description: 对象的key - -x-bucket-content-type: - name: Content-Type - type: string - in: header - description: 对象的content-type - -x-bucket-content-length: - name: Content-Length - type: string - in: header - description: 对象的content-length - -x-bucket-storage-class: - name: X-Yunion-Bucket-Upload-Storageclass - type: string - in: header - description: 对象的storage_class - -x-bucket-acl: - name: X-Yunion-Bucket-Upload-Acl - type: string - in: header - description: 对象的acl，可能值为：private, public-read, public-read-write diff --git a/docs/parameters/cloudaccount.yaml b/docs/parameters/cloudaccount.yaml deleted file mode 100644 index 139c952853..0000000000 --- a/docs/parameters/cloudaccount.yaml +++ /dev/null @@ -1,25 +0,0 @@ -cloudaccountId: - name: cloudaccountId - type: string - required: true - in: path - description: 账号名称或ID - -scope: - name: scope - in: body - type: string - enum: [project, domain, system] - default: system - description: specify scope, either project, domain or system - -shared_projects: - name: shared_projects - in: body - type: array - items: - type: string - example: test-project - description: 项目名称或ID - description: 共享到的项目列表, 仅scope=project有效 - diff --git a/docs/parameters/common.yaml b/docs/parameters/common.yaml deleted file mode 100644 index a6baa8bd61..0000000000 --- a/docs/parameters/common.yaml +++ /dev/null @@ -1,143 +0,0 @@ -offset: - name: offset - in: query - type: integer - default: 0 - description: 查询偏移量 -limit: - name: limit - in: query - type: integer - default: 20 - description: 查询限制量 -admin: - name: admin - in: query - type: boolean - default: false - description: obsolete, equivalent to scope=system -scope: - name: scope - in: query - type: string - default: project - description: specify query scope, either project, domain or system -search: - name: search - in: query - type: string - description: 模糊查询, 对结果中任意字符串字段进行包含该字符串的过滤 -billing_type: - name: billing_type - in: query - type: string - enum: [postpaid, prepaid] - description: 指定计费类型 -provider: - name: provider - in: query - type: string - description: 根据平台过滤 -account: - name: account - in: query - type: string - description: 根据账号过滤 -cloudaccount: - name: account - in: query - type: string - description: 根据账号过滤 -cloudprovider: - name: cloudprovider - in: query - type: string - description: 根据账号子订阅过滤 -brand: - name: brand - in: query - type: string - description: 根据品牌过滤 -zone: - name: zone - in: query - type: string - description: 过滤可用区底下的资源 -wire: - name: wire - in: query - type: string - description: 过滤连接此二层网络的资源 -network: - name: network - in: query - type: string - description: 过滤关联词网络的资源 -vpc: - name: vpc - in: query - type: string - description: 过滤连接此VPC的资源 -region: - name: region - in: query - type: string - description: 过滤此区域底下的资源 -cloud_env: - name: cloud_env - in: query - type: string - enum: [public,private,onpremise] - description: 根据云环境过滤资源 -city: - name: city - in: query - type: string - description: 根据城市过滤资源 -cloudregion: - name: cloudregion - in: query - type: string - description: 根据区域过滤列表 -pending_delete: - name: pending_delete - in: query - type: string - default: true - enum: [true,false,all] - description: 默认不显示回收站资源，true则只显示回收站资源，all则显示所有资源，含不再回收站和在回收站的资源支持实例,磁盘,镜像过滤 -override_pending_delete: - name: override_pending_delete - in: query - type: boolean - description: 从回收站删除资源时需要指定此参数为true, 回收站资源到期会自动释放。到期清理时间由服务参数PendingDeleteExpireSeconds确定。默认是259200秒（3天） -name: - name: name - in: body - type: string - description: 更新资源的名称 -description: - name: description - in: body - type: string - description: 更新资源的描述 -public_cloud: - name: public_cloud - in: query - type: boolean - description: 过滤公有云资源 -private_cloud: - name: private_cloud - in: query - type: boolean - description: 过滤公有云资源 -is_on_premise: - name: is_on_premise - in: query - type: boolean - description: 过滤本地IDC资源 -is_managed: - name: is_managed - in: query - type: boolean - description: 过滤通过云账号导入进来的资源 diff --git a/docs/parameters/credential.yaml b/docs/parameters/credential.yaml deleted file mode 100644 index daaad498b2..0000000000 --- a/docs/parameters/credential.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: - name: type - type: string - in: query - example: totp - description: 以type字段过滤列表结果, 例如totp, recovery_secret - -user_id: - name: user_id - type: string - in: query - description: 以user_id过滤指定用户的credentials - diff --git a/docs/parameters/dbinstance.yaml b/docs/parameters/dbinstance.yaml deleted file mode 100644 index 01b601cb4e..0000000000 --- a/docs/parameters/dbinstance.yaml +++ /dev/null @@ -1,49 +0,0 @@ -dbinstanceId: - name: dbinstanceId - required: true - in: path - type: string - description: RDS实例名称或ID,建议使用ID - -parameterId: - name: parameterId - required: true - in: path - type: string - description: RDS实例参数名称或ID,建议使用ID - -databaseId: - name: databaseId - required: true - in: path - type: string - description: RDS实例数据库名称或ID,建议使用ID - -backupId: - name: backupId - required: true - in: path - type: string - description: RDS实例备份名称或ID,建议使用ID - - -accountId: - name: accountId - required: true - in: path - type: string - description: RDS实例用户名称或ID,建议使用ID - - -dbinstance: - name: dbinstance - in: query - type: string - description: 根据RDS实例名称或ID过滤资源 - -keep_backup: - name: keep_backup - in: body - type: boolean - default: false - description: 删除RDS实例时保留手动备份 diff --git a/docs/parameters/dbinstance_sku.yaml b/docs/parameters/dbinstance_sku.yaml deleted file mode 100644 index 89596f5673..0000000000 --- a/docs/parameters/dbinstance_sku.yaml +++ /dev/null @@ -1,6 +0,0 @@ -skuId: - name: skuId - required: true - in: path - type: string - description: RDS套餐ID diff --git a/docs/parameters/disk.yaml b/docs/parameters/disk.yaml deleted file mode 100644 index 7fa8dba7e1..0000000000 --- a/docs/parameters/disk.yaml +++ /dev/null @@ -1,57 +0,0 @@ -diskId: - name: diskId - required: true - in: path - type: string - description: 磁盘名称或ID -unused: - name: unused - required: false - in: query - type: boolean - description: 列出未挂载磁盘 -share: - name: share - required: false - in: query - type: boolean - description: 列出共享磁盘 -local: - name: local - required: false - in: query - type: boolean - description: 列出本地磁盘 -guest: - name: guest - required: false - in: query - type: string - description: 列出改虚拟机的磁盘 -storage: - name: storage - required: false - in: query - type: string - description: 列出改存储的磁盘 -type: - name: type - required: false - in: query - type: string - enum: [sys,data,swap,volume] - description: 列出改类型的磁盘 -cloud_type: - name: cloud_type - required: false - in: query - type: string - enum: [Public,Private] - description: 列出公有云或私有云的磁盘 -snapshotpolicy_id: - name: snapshotpolicy_id - required: false - in: query - type: string - description: 列出绑定了此快照策略的磁盘 - diff --git a/docs/parameters/domain.yaml b/docs/parameters/domain.yaml deleted file mode 100644 index 14d586e8c9..0000000000 --- a/docs/parameters/domain.yaml +++ /dev/null @@ -1,6 +0,0 @@ -domain_id: - name: domain_id - type: string - required: true - in: path - description: 域ID diff --git a/docs/parameters/elasticcache.yaml b/docs/parameters/elasticcache.yaml deleted file mode 100644 index dd3e8cf8ca..0000000000 --- a/docs/parameters/elasticcache.yaml +++ /dev/null @@ -1,52 +0,0 @@ -elasticcacheId: - name: elasticcacheId - required: true - in: path - type: string - description: ElasticCache实例名称或ID,建议使用ID - -parameterId: - name: parameterId - required: true - in: path - type: string - description: ElasticCache实例参数名称或ID,建议使用ID - -aclId: - name: aclId - required: true - in: path - type: string - description: ElasticCache实例访问控制名称或ID,建议使用ID - -backupId: - name: backupId - required: true - in: path - type: string - description: ElasticCache实例备份名称或ID,建议使用ID - -accountId: - name: accountId - required: true - in: path - type: string - description: ElasticCache实例用户名称或ID,建议使用ID - -elasticcache_id: - name: elasticcache_id - in: query - type: string - description: 根据ElasticCache实例名称或ID过滤资源 - -engine_version: - name: engine_version - in: query - type: string - description: 根据ElasticCache实例版本过滤资源 - -local_category: - name: local_category - in: query - type: string - description: 根据ElasticCache类型过滤资源 diff --git a/docs/parameters/elasticip.yaml b/docs/parameters/elasticip.yaml deleted file mode 100644 index 3759b44288..0000000000 --- a/docs/parameters/elasticip.yaml +++ /dev/null @@ -1,63 +0,0 @@ -elasticipId: - name: elasticipId - required: true - in: path - type: string - description: 弹性IP名称或者ID - -usable_eip_for_associate_type: - name: usable_eip_for_associate_type - required: false - in: query - type: string - enum: [server] - example: server - description: 关联资源类型,和usable_eip_for_associate_id配合使用过滤可关联的eip列表 - -usable_eip_for_associate_id: - name: usable_eip_for_associate_id - required: false - in: query - type: string - example: 6c7d1cc2-1877-458c-8109-b7528a81c2d6 - description: 关联资源id,和usable_eip_for_associate_type配合使用过滤可关联的eip列表 - -usable: - name: usable - required: false - in: query - type: boolean - example: true - description: 过滤状态为ready并且未被绑定的eip列表 - -instance_id: - name: instance_id - required: true - in: body - type: string - example: 6c7d1cc2-1877-458c-8109-b7528a81c2d6 - description: 实例名称或ID - -instance_type: - name: instance_type - required: true - in: body - type: string - enum: [server] - example: server - description: 实例类型，目前仅支持server - -bandwidth: - name: bandwidth - in: body - type: integer - example: 10 - description: 修改的带宽大小,单位(Mbps),目前腾讯云和微软云不支持修改带宽 - -auto_delete: - name: auto_delete - in: body - type: boolean - default: false - example: false - description: 解绑弹性EIP后自动删除弹性EIP \ No newline at end of file diff --git a/docs/parameters/endpoint.yaml b/docs/parameters/endpoint.yaml deleted file mode 100644 index 56ad3411f1..0000000000 --- a/docs/parameters/endpoint.yaml +++ /dev/null @@ -1,6 +0,0 @@ -endpoint_id: - name: endpoint_id - type: string - required: true - in: path - description: 服务接入点ID diff --git a/docs/parameters/group.yaml b/docs/parameters/group.yaml deleted file mode 100644 index 05a689c9b0..0000000000 --- a/docs/parameters/group.yaml +++ /dev/null @@ -1,6 +0,0 @@ -group_id: - name: group_id - type: string - required: true - in: path - description: 组ID diff --git a/docs/parameters/host.yaml b/docs/parameters/host.yaml deleted file mode 100644 index 3154d23454..0000000000 --- a/docs/parameters/host.yaml +++ /dev/null @@ -1,80 +0,0 @@ -hostId: - name: hostId - required: true - in: path - type: string - description: 宿主机名称或ID -enable: - name: enable - required: false - in: query - type: boolean - description: 列出enable的宿主机 -disable: - name: disable - required: false - in: query - type: boolean - description: 列出disable的宿主机 -host_type: - name: host_type - required: false - in: query - type: string - enum: [baremetal,hypervisor,esxi,kubelet,hyperv,aliyun,azure,qcloud,aws,huawei,ucloud] - description: 列出指定类型的宿主机 -is_empty: - name: is_empty - required: false - in: query - type: boolean - description: 列出资源未被使用的宿主机 -storage: - name: storage - required: false - in: query - type: string - description: 列出指定存储挂载的宿主机 -usable: - name: usable - required: false - in: query - type: boolean - description: 列出可用的宿主机 -hypervisor: - name: hypervisor - required: false - in: query - type: string - description: 列出指定hypervisor的宿主机 -any_mac: - name: any_mac - required: false - in: query - type: string - description: 列出指定mac的宿主机 -cachedimage: - name: cachedimage - required: false - in: query - type: string - description: 列出缓存了改镜像的宿主机 -is_baremetal: - name: is_baremetal - required: false - in: query - type: boolean - description: 列出物理机 -resource_type: - name: resource_type - required: false - in: query - type: string - enum: [shared,prepaid,dedicated] - description: 列出指定资源类型的宿主机 -storage_not_attached: - name: resource_type - required: false - in: query - type: string - description: 列出未挂载存储的宿主机 \ No newline at end of file diff --git a/docs/parameters/hoststorage.yaml b/docs/parameters/hoststorage.yaml deleted file mode 100644 index bca850284f..0000000000 --- a/docs/parameters/hoststorage.yaml +++ /dev/null @@ -1,12 +0,0 @@ -storage: - name: storage - required: true - in: path - type: string - description: 存储名称或者ID -host: - name: host - required: true - in: path - type: string - description: 宿主机名称或者ID \ No newline at end of file diff --git a/docs/parameters/identity.yaml b/docs/parameters/identity.yaml deleted file mode 100644 index a1fad4bd21..0000000000 --- a/docs/parameters/identity.yaml +++ /dev/null @@ -1,29 +0,0 @@ -project_domain: - name: project_domain - type: string - in: query - description: 以域的名称或者ID过滤列表结果 - -project_id: - name: project_id - type: string - in: path - description: 项目ID - -user_id: - name: user_id - type: string - in: path - description: 用户ID - -group_id: - name: group_id - type: string - in: path - description: 组ID - -role_id: - name: role_id - type: string - in: path - description: 角色ID diff --git a/docs/parameters/identity_provider.yaml b/docs/parameters/identity_provider.yaml deleted file mode 100644 index 4fd2236d1a..0000000000 --- a/docs/parameters/identity_provider.yaml +++ /dev/null @@ -1,6 +0,0 @@ -idp_id: - name: idp_id - type: string - required: true - in: path - description: 认证源ID diff --git a/docs/parameters/image.yaml b/docs/parameters/image.yaml deleted file mode 100644 index 949567adcd..0000000000 --- a/docs/parameters/image.yaml +++ /dev/null @@ -1,71 +0,0 @@ -imageId: - name: imageId - required: true - in: path - type: string - description: 镜像名称或ID,建议使用ID -is_public: - name: is_public - in: query - type: boolean - description: 查询标准镜像 -owner: - name: owner - in: query - type: string - description: 查询某个项目的镜像列表 -name: - name: name - in: query - type: string - description: 查询某个镜像 -disk_format: - name: disk_format - in: query - type: string - description: 查询指定格式的镜像 -disk_formats: - name: disk_formats - in: query - type: array - items: - type: string - description: 查询某些格式的镜像 - -x-image-meta-name: - name: x-image-meta-name - type: string - in: header - description: 镜像名称 -x-image-meta-is_public: - name: x-image-meta-is_public - type: boolean - in: header - description: 是否是标准镜像 -x-image-meta-description: - name: x-image-meta-description - type: string - in: header - description: 镜像描述信息 -x-image-meta-property-os_arch: - name: x-image-meta-property-os_arch - type: string - in: header - description: 操作系统架构 -x-image-meta-property-os_distribution: - name: x-image-meta-property-os_distribution - type: string - in: header - description: 操作系统发行版 -x-image-meta-property-os_version: - name: x-image-meta-property-os_version - type: string - in: header - description: 操作系统版本 -content-type: - name: Content-Type - required: true - type: string - in: header - example: application/octet-stream - enum: [application/octet-stream] diff --git a/docs/parameters/instance.yaml b/docs/parameters/instance.yaml deleted file mode 100644 index 5e268b3682..0000000000 --- a/docs/parameters/instance.yaml +++ /dev/null @@ -1,72 +0,0 @@ -instanceId: - name: instanceId - required: true - in: path - type: string - description: 实例名称或ID,建议使用ID -baremetal: - name: baremetal - in: query - type: boolean - description: 过滤裸金属类型实例 -hypervisor: - name: hypervisor - in: query - type: string - enum: [kvm,esxi,container,baremetal,aliyun,azure,aws,huawei,ucloud,qcloud,openstack,zstack] - description: 过滤虚拟化平台底下的实例 -host: - name: host - in: query - type: string - description: 过滤宿主机上的实例 -secgroup: - name: secgroup - in: query - type: string - description: 过滤关联了此安全组的实例 -disk: - name: disk - in: query - type: string - description: 过滤挂载此硬盘的实例 -with_eip: - name: with_eip - in: query - type: boolean - enum: [true] - description: 过滤关联的eip的实例 -without_eip: - name: without_eip - in: query - type: boolean - enum: [true] - description: 过滤未关联eip的实例 -gpu: - name: gpu - in: query - type: boolean - enum: [true, false] - description: 过滤关联GPU卡的实例 -order_by_disk: - name: order_by_disk - in: query - type: string - enum: [desc, asc] - description: 根据磁盘大小排序 -order_by_host: - name: order_by_host - in: query - type: string - enum: [desc, asc] - description: 根据宿主机名称排序 -usable_server_for_eip: - name: usable_server_for_eip - in: query - type: string - description: 过滤此EIP可绑定的server列表(实例和弹性IP属于同一个账号同一个区域,若是私有云则弹性IP和实例需要在同一个可用区) -group: - name: group - in: query - type: string - description: 主机组的ID或者Name \ No newline at end of file diff --git a/docs/parameters/instancegroup.yaml b/docs/parameters/instancegroup.yaml deleted file mode 100644 index b466621963..0000000000 --- a/docs/parameters/instancegroup.yaml +++ /dev/null @@ -1,13 +0,0 @@ -instancegroupId: - name: instancegroupId - required: true - in: path - description: 实例组的ID -granularity: - name: granularity - in: query - description: 粒度 -guest: - name: guest - in: query - description: 主机的ID或者Name diff --git a/docs/parameters/keypair.yaml b/docs/parameters/keypair.yaml deleted file mode 100644 index 3f3d6a12b1..0000000000 --- a/docs/parameters/keypair.yaml +++ /dev/null @@ -1,13 +0,0 @@ -keypairId: - name: keypairId - required: true - in: path - type: string - description: 秘钥对名称或者ID - -admin: - name: admin - required: false - in: path - type: boolean - description: 是否列出所有秘钥信息 diff --git a/docs/parameters/loadbalancer.yaml b/docs/parameters/loadbalancer.yaml deleted file mode 100644 index e2122331d6..0000000000 --- a/docs/parameters/loadbalancer.yaml +++ /dev/null @@ -1,118 +0,0 @@ -loadbalancerId: - name: loadbalancerId - type: string - in: path - required: true -loadbalancerlistenerId: - name: loadbalancerlistenerId - type: string - in: path - required: true -loadbalancerlistenerruleId: - name: loadbalancerlistenerruleId - type: string - in: path - required: true -loadbalancerbackendgroupId: - name: loadbalancerbackendgroupId - type: string - in: path - required: true - description: 后端服务器组ID -loadbalancerbackendId: - name: loadbalancerbackendId - type: string - in: path - required: true -loadbalancercachedaclId: - name: loadbalancercachedaclId - type: string - in: path - required: true - description: 访问控制缓存id -loadbalancercachedcertificateId: - name: loadbalancercachedcertificateId - type: string - in: path - required: true - description: 证书缓存id -loadbalancerClusterId: - name: loadbalancerClusterId - type: string - in: path - required: true - description: Loadbalancer集群id -loadbalancerAgentId: - name: loadbalancerAgentId - type: string - in: path - required: true - description: Loadbalancer转发实例id - - -address: - name: address - in: query - type: string - description: 指定virtual ip地址 - -loadbalancer: - name: loadbalancer - in: query - type: string - description: 指定loadbalaner实例uuid -listener_type: - name: listener_type - in: query - type: string - enum: - - tcp - description: 指定loadbalaner监听协议 -listener_port: - name: listener_port - in: query - type: integer - description: 指定loadbalaner监听端口 - -backend_group: - name: backend_group - in: query - type: string - description: 指定loadbalaner后端服务器组uuid -port: - name: port - in: query - type: integer - description: 指定real port -acl_id: - name: acl_id - in: query - type: string - description: 指定loadbalaner本地访问控制id -certificate_id: - name: certificate_id - in: query - type: string - description: 指定loadbalaner本地证书id - -listener: - name: listener - in: query - type: string - description: 指定loadbalancer监听id -domain: - name: domain - in: query - type: string - description: 指定转发规则匹配的域名 -path: - name: path - in: query - type: string - description: 指定转发规则匹配的路径 - -cluster: - name: cluster - in: query - type: string - description: 指定loadbalancer集群id diff --git a/docs/parameters/natgateway.yaml b/docs/parameters/natgateway.yaml deleted file mode 100644 index 74e5dbbdf5..0000000000 --- a/docs/parameters/natgateway.yaml +++ /dev/null @@ -1,29 +0,0 @@ -natgatewayId: - name: natgatewayId - required: true - in: path - type: string - description: NAT网关的ID -dnatentryId: - name: dnatentryId - required: true - in: path - type: string - description: DNAT的ID -snatentryId: - name: snatentryId - required: true - in: path - type: string - description: SNAT的ID - -natgateway: - name: natgateway - in: query - type: string - description: 根据NAT过滤 -network: - name: network - in: query - type: string - description: 根据子网过滤列表 diff --git a/docs/parameters/network.yaml b/docs/parameters/network.yaml deleted file mode 100644 index 98d10ae1bf..0000000000 --- a/docs/parameters/network.yaml +++ /dev/null @@ -1,36 +0,0 @@ -networkId: - name: networkId - required: true - in: path - type: string - description: IP子网名称或者ID -ip: - name: ip - in: query - type: string - description: 查询包含这个IP的网络 -zone: - name: zone - in: query - type: string - description: 查询在这个zone中的网络 -wire: - name: wire - in: query - type: string - description: 查询在这个wire中的网络 -vpc: - name: vpc - in: query - type: string - description: 查询在这个VPC中的网络 -region: - name: region - in: query - type: string - description: 查询在这个region中的网络 -server_type: - name: server_type - in: query - type: string - description: 查询指定server_type的网络 \ No newline at end of file diff --git a/docs/parameters/networkinterface.yaml b/docs/parameters/networkinterface.yaml deleted file mode 100644 index 81283d1f93..0000000000 --- a/docs/parameters/networkinterface.yaml +++ /dev/null @@ -1,6 +0,0 @@ -networkinterfaceId: - name: networkinterfaceId - required: true - in: path - type: string - description: 弹性网卡名称或ID,建议使用ID \ No newline at end of file diff --git a/docs/parameters/policy.yaml b/docs/parameters/policy.yaml deleted file mode 100644 index 1e347102c2..0000000000 --- a/docs/parameters/policy.yaml +++ /dev/null @@ -1,6 +0,0 @@ -policy_id: - name: policy_id - type: string - required: true - in: path - description: 权限ID或者名称 diff --git a/docs/parameters/project.yaml b/docs/parameters/project.yaml deleted file mode 100644 index 4198faa9ea..0000000000 --- a/docs/parameters/project.yaml +++ /dev/null @@ -1,6 +0,0 @@ -project_id: - name: project_id - type: string - required: true - in: path - description: 项目ID diff --git a/docs/parameters/quota.yaml b/docs/parameters/quota.yaml deleted file mode 100644 index 37a0ded842..0000000000 --- a/docs/parameters/quota.yaml +++ /dev/null @@ -1,58 +0,0 @@ -scope: - name: scope - in: query - type: string - description: 指定所查询的配额的作用范围，可能的值为project|domain。如果为project，则查询当前项目的配额，缺省为project。如果为domain，则查询当前项目的配额。 - -project_id: - name: project_id - in: path - required: true - type: string - description: 查询指定项目的配额 - -domain_id: - name: domain_id - in: path - required: true - type: string - description: 查询指定域的配额 - -project_domain: - name: project_domain - in: query - type: string - description: 指定查询的域名称或者ID - -quotas: - name: quotas - in: body - required: true - type: object - description: 设置配额信息 - properties: - action: - type: string - description: 设置配额的方式，可能值为set，replace, add和reset，分别代表设置配额，替换配额，增加配额和重置为初始配额四种方式 - default: set - cascade: - type: boolean - description: 设置项目配额时，如果项目总配额超过域配额，则自动调整域配额 - cpu: - type: integer - description: 设置CPU配额，单位为个 - memory: - type: integer - description: 设置内存配额，单位为MB - storage: - type: integer - description: 设置磁盘配额，单位为MB - isolated_device: - type: integer - description: 设置GPU配额，单位为块 - snapshot: - type: integer - description: 设置快照配额，单位为MB - image: - type: integer - description: 设置镜像配额，单位为个 diff --git a/docs/parameters/region.yaml b/docs/parameters/region.yaml deleted file mode 100644 index ca95164f9c..0000000000 --- a/docs/parameters/region.yaml +++ /dev/null @@ -1,6 +0,0 @@ -region_id: - name: region_id - type: string - required: true - in: path - description: 区域ID diff --git a/docs/parameters/role.yaml b/docs/parameters/role.yaml deleted file mode 100644 index 91d8da7a62..0000000000 --- a/docs/parameters/role.yaml +++ /dev/null @@ -1,6 +0,0 @@ -role_id: - name: role_id - type: string - required: true - in: path - description: 角色ID diff --git a/docs/parameters/roleassignments.yaml b/docs/parameters/roleassignments.yaml deleted file mode 100644 index 5d0828f8b3..0000000000 --- a/docs/parameters/roleassignments.yaml +++ /dev/null @@ -1,53 +0,0 @@ -user.id: - name: user.id - type: string - in: query - description: 只列出指定用户的项目角色信息 - -group.id: - name: group.id - type: string - in: query - description: 只列出指定组的项目角色信息 - -role.id: - name: role.id - type: string - in: query - description: 只列出指定角色的用户和组加入项目的信息 - -scope.domain.id: - name: scope.domain.id - type: string - in: query - description: 只列出指定域下的项目的用户或者组加入项目的信息 - -scope.project.id: - name: scope.project.id - type: string - in: query - description: 只列出指定项目的用户或者组加入的信息 - -include_names: - name: include_names - type: boolean - in: query - description: 结果包含用户，组，项目，角色的名称 - -effective: - name: effective - type: boolean - in: query - description: 把组加入项目的信息展开，只显示用户加入项目的信息 - -include_system: - name: include_system - type: boolean - in: query - description: 包含系统用户的角色项目信息 - -include_policies: - name: include_policies - type: boolean - in: query - description: 是否在结果中包含用户在该项目的角色匹配的权限列表 diff --git a/docs/parameters/secgroup.yaml b/docs/parameters/secgroup.yaml deleted file mode 100644 index bc8b897e0a..0000000000 --- a/docs/parameters/secgroup.yaml +++ /dev/null @@ -1,30 +0,0 @@ -secgroupId: - name: secgroupId - required: true - in: path - type: string - description: 安全组名称或者ID - -scope: - name: scope - in: body - type: string - enum: [project, domain, system] - default: system - description: specify scope, either project, domain or system - -shared_projects: - name: shared_projects - in: body - type: array - items: - type: string - example: test-project - description: 项目名称或ID - description: 共享到的项目列表, 仅scope=project有效 - -server: - name: server - in: query - type: string - description: Filter secgroups bound to specified server diff --git a/docs/parameters/secgroupcache.yaml b/docs/parameters/secgroupcache.yaml deleted file mode 100644 index 68e69b3752..0000000000 --- a/docs/parameters/secgroupcache.yaml +++ /dev/null @@ -1,13 +0,0 @@ -cacheId: - name: cacheId - required: true - in: path - type: string - description: 安全组缓存ID - - -secgroup: - name: secgroup - in: query - type: string - description: 安全组ID,仅过滤此安全组底下的缓存 diff --git a/docs/parameters/secgrouprule.yaml b/docs/parameters/secgrouprule.yaml deleted file mode 100644 index cea163ab65..0000000000 --- a/docs/parameters/secgrouprule.yaml +++ /dev/null @@ -1,12 +0,0 @@ -secgroupruleId: - name: secgroupruleId - required: true - in: path - type: string - description: 安全组规则ID - -secgroup: - name: secgroup - in: body - type: string - description: 安全组名称或ID \ No newline at end of file diff --git a/docs/parameters/serversku.yaml b/docs/parameters/serversku.yaml deleted file mode 100644 index 7403c2f050..0000000000 --- a/docs/parameters/serversku.yaml +++ /dev/null @@ -1,27 +0,0 @@ -serverskuId: - name: serverskuId - required: true - in: path - type: string - description: 实例套餐名称或ID,建议使用ID -memory_size_mb: - name: memory_size_mb - in: query - type: integer - description: 根据内存大小过滤套餐 -provider: - name: provider - in: query - type: string - description: 根据平台过滤套餐信息,若平台是Huawei,建议加上instance_type_family.notin(e1, e2, e3, d1, d2, i3, h2, g1, g3, p2v, p1, pi1, fp1, fp1c)过滤FPGA镜像 -usable: - name: usable - in: query - type: boolean - description: 过滤所在region底下有ip子网的套餐 -purge: - name: purge - in: body - type: boolean - default: false - description: 删除本地套餐时不同步删除私有云上的套餐 diff --git a/docs/parameters/service.yaml b/docs/parameters/service.yaml deleted file mode 100644 index 537868fa4e..0000000000 --- a/docs/parameters/service.yaml +++ /dev/null @@ -1,6 +0,0 @@ -service_id: - name: service_id - type: string - required: true - in: path - description: 服务ID diff --git a/docs/parameters/snapshotpolicy.yaml b/docs/parameters/snapshotpolicy.yaml deleted file mode 100644 index a971785e11..0000000000 --- a/docs/parameters/snapshotpolicy.yaml +++ /dev/null @@ -1,28 +0,0 @@ -snapshotpolicyId: - name: snapshotpolicyId - required: true - in: path - description: 自动快照策略的ID -diskId: - name: diskId - in: path - description: 磁盘的ID -retention_days: - name: retention_days - in: query - type: integer - description: 快照的保存时间（永久保存选-1） -repeat_weekdays: - name: repeat_weekdays - in: query - type: array - items: - type: integer - description: 做快照的时间（周几） -time_points: - name: time_points - in: query - type: array - items: - type: integer - description: 做快照的时间（每天几点） \ No newline at end of file diff --git a/docs/parameters/storage.yaml b/docs/parameters/storage.yaml deleted file mode 100644 index faac50141c..0000000000 --- a/docs/parameters/storage.yaml +++ /dev/null @@ -1,24 +0,0 @@ -storageId: - name: storageId - required: true - in: path - type: string - description: 存储名称或者ID -share: - name: share - in: query - type: bool - default: false - description: 查询共享存储 -local: - name: local - in: query - type: bool - default: false - description: 查询本地存储 -usable: - name: usable - in: query - type: bool - default: false - description: 查询可用的存储 diff --git a/docs/parameters/storagecache.yaml b/docs/parameters/storagecache.yaml deleted file mode 100644 index 7765142f06..0000000000 --- a/docs/parameters/storagecache.yaml +++ /dev/null @@ -1,22 +0,0 @@ -storagecacheId: - name: storagecacheId - required: true - in: path - type: string - description: 存储缓存名称或ID -image: - name: image - in: body - required: true - type: string - description: 镜像名称或ID -is_force: - name: is_force - in: body - type: string - description: 是否强制缓存镜像(会覆盖之前已缓存的镜像) -format: - name: format - in: body - type: string - description: 缓存镜像的格式(有的云对镜像有特殊格式要求，会导致此参数失效) diff --git a/docs/parameters/user.yaml b/docs/parameters/user.yaml deleted file mode 100644 index af05af4e99..0000000000 --- a/docs/parameters/user.yaml +++ /dev/null @@ -1,12 +0,0 @@ -system: - name: system - type: boolean - in: query - description: 是否显示系统账号用户，默认为否 - -user_id: - name: user_id - type: string - required: true - in: path - description: 用户ID diff --git a/docs/quotas/domainquotas.yaml b/docs/quotas/domainquotas.yaml deleted file mode 100644 index e9e13568e1..0000000000 --- a/docs/quotas/domainquotas.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获得指定域的配额 - parameters: - - $ref: "../parameters/quota.yaml#/domain_id" - responses: - 200: - description: 配额信息 - schema: - $ref: "../schemas/quota.yaml#/QuotaGetResponse" - tags: - - quota - -post: - summary: 设置指定域的配额 - parameters: - - $ref: "../parameters/quota.yaml#/domain_id" - - $ref: "../parameters/quota.yaml#/quotas" - responses: - 200: - description: 设置成功 - tags: - - quota diff --git a/docs/quotas/projectquotalist.yaml b/docs/quotas/projectquotalist.yaml deleted file mode 100644 index 4ad561f4a3..0000000000 --- a/docs/quotas/projectquotalist.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取当前域或者指定域下所有项目的配额信息 - parameters: - - $ref: "../parameters/quota.yaml#/project_domain" - responses: - 200: - description: 配额信息 - schema: - $ref: "../schemas/quota.yaml#/QuotaListResponse" - tags: - - quota diff --git a/docs/quotas/projectquotas.yaml b/docs/quotas/projectquotas.yaml deleted file mode 100644 index be4b77130f..0000000000 --- a/docs/quotas/projectquotas.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获得指定项目的配额 - parameters: - - $ref: "../parameters/quota.yaml#/project_id" - responses: - 200: - description: 配额信息 - schema: - $ref: "../schemas/quota.yaml#/QuotaGetResponse" - tags: - - quota - -post: - summary: 设置指定项目的配额 - parameters: - - $ref: "../parameters/quota.yaml#/project_id" - - $ref: "../parameters/quota.yaml#/quotas" - responses: - 200: - description: 设置成功 - tags: - - quota diff --git a/docs/quotas/quotalist.yaml b/docs/quotas/quotalist.yaml deleted file mode 100644 index b6b753b1c8..0000000000 --- a/docs/quotas/quotalist.yaml +++ /dev/null @@ -1,9 +0,0 @@ -get: - summary: 获取全局所有域的配额信息 - responses: - 200: - description: 配额信息 - schema: - $ref: "../schemas/quota.yaml#/QuotaListResponse" - tags: - - quota diff --git a/docs/quotas/quotas.yaml b/docs/quotas/quotas.yaml deleted file mode 100644 index 364b6f5942..0000000000 --- a/docs/quotas/quotas.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获得用户所在项目的配额 - parameters: - - $ref: '../parameters/quota.yaml#/scope' - responses: - 200: - description: 配额信息 - schema: - $ref: "../schemas/quota.yaml#/QuotaGetResponse" - tags: - - quota diff --git a/docs/schemas/ansibleplaybook.yaml b/docs/schemas/ansibleplaybook.yaml deleted file mode 100644 index 9ce09cd576..0000000000 --- a/docs/schemas/ansibleplaybook.yaml +++ /dev/null @@ -1,126 +0,0 @@ -AnsiblePlaybook: - type: object - description: AnsiblePlaybook实例 - properties: - id: - type: string - description: 实例uuid - readOnly: true - name: - type: string - description: 实例名称 - inventory: - type: array - description: 被操作主机列表 - items: - $ref: "#/AnsiblePlaybookInventoryHost" - modules: - type: array - description: playbook任务列表 - items: - $ref: "#/AnsiblePlaybookModule" - files: - type: object - description: | - Ansible执行时所需的文件名称和对应内容 - example: - influxdb/influxdb.conf.j2: xxx - kapacitor/kapacitor.conf.j2: xxx - output: - type: string - description: ansibleplaybook执行记录 - start_time: - type: string - description: playbook执行开始时间 - format: date-time - end_time: - type: string - description: playbook执行结束时间 - format: date-time - status: - type: string - description: playbook当前执行状态 - enum: - - running - - succeeded - - failed - - canceled - - unknown - -AnsiblePlaybookInventoryHost: - type: object - description: Ansible Playbook Inventory主机描述 - properties: - name: - type: string - description: | - 被操作目标主机描述 - - 支持以下几种类型，格式描述如下 - - - 云平台虚机id或名称：[server:]name-or-id - - 指定云平台宿主机：host:name-or-id - - 非纳管的机器，直接指定IP地址 - - 若通过直接指定IP地址的方式尝试对非纳管的机器进行操作，对于目标机器有以下要求 - - - ansibleserver服务能够访问目标机器 - - 目标机器 - - 安装了OpenSSH和Python - - 存在用户`cloudroot` - - 能够通过管理员或项目ssh pubkey免密登录cloudroot - - 若需要`ansible_become`，则要求cloudroot用户能够免密使用sudo - - 举例 - - - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - - host:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - - 10.168.222.236 - - 指定云平台虚机或宿主机时，后端会取相应的内网IP地址对其进行访问 - example: server:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - vars: - type: object - description: 键值方式描述该主机相关的参数 - example: - ansible_become: yes - -AnsiblePlaybookModule: - type: object - description: Ansible Playbook Module描述 - properties: - name: - type: string - description: ansible模块名称 - args: - type: array - description: ansible模块参数描述 - items: - type: string - example: - name: package - args: - - name=nginx - - state=installed - -AnsiblePlaybookCreateRequest: - type: object - properties: - name: - type: string - description: playbook名称 - ansibleplaybook: - $ref: '#/AnsiblePlaybook' -AnsiblePlaybookListResponse: - type: object - properties: - ansibleplaybooks: - type: array - items: - $ref: '#/AnsiblePlaybook' -AnsiblePlaybookResponse: - type: object - properties: - ansibleplaybook: - type: object - $ref: '#/AnsiblePlaybook' diff --git a/docs/schemas/auth.yaml b/docs/schemas/auth.yaml deleted file mode 100644 index 5a2c7cadcd..0000000000 --- a/docs/schemas/auth.yaml +++ /dev/null @@ -1,344 +0,0 @@ -AuthContext: - type: object - properties: - source: - type: string - description: 认证来源，可能值为web, api, cli, srv - ip: - type: string - description: 认证发起的IP地址 - -Auth2Input: - type: object - properties: - password_credentials: - type: object - description: 采用用户名／密码认证时，用来认证的密码认证信息 - properties: - username: - type: string - description: 用户名 - password: - type: string - description: 密码 - tenant_name: - type: string - description: 项目名称 - tenant_id: - type: string - description: 项目ID - token: - type: object - description: 采用token认证时，用来认证的token信息 - properties: - id: - type: string - description: token - context: - type: object - $ref: '#/AuthContext' - -Auth2Response: - type: object - properties: - access: - type: object - $ref: '#/Token2' - -Token2: - type: object - properties: - token: - type: object - description: token信息 - properties: - id: - type: string - description: token字符串 - expires: - type: string - format: date-time - description: token到期时间 - tenant: - type: object - description: token所属的项目信息 - $ref: '#/TenantV2' - service_catalog: - type: array - description: 服务目录 - items: - $ref: '#/ServiceV2' - user: - type: object - description: token关联的用户信息 - properties: - id: - type: string - description: 用户ID - name: - type: string - description: 用户名称 - username: - type: string - description: 用户的显示名称 - roles: - type: array - items: - type: object - description: 用户角色 - properties: - name: - type: string - description: 用户角色名称 - tenants: - type: array - items: - $ref: '#/TenantV2' - metadata: - type: object - properties: - is_admin: - type: integer - description: 是否为管理员 - roles: - type: array - description: 角色名称列表 - items: - type: string - description: 角色名称 - context: - type: object - $ref: '#/AuthContext' - -TenantV2: - type: object - description: keystone v2项目信息 - properties: - id: - type: string - description: 项目ID - name: - type: string - description: 项目名称 - enabled: - type: boolean - description: 项目是否启用 - description: - type: string - description: 项目描述 - domain: - type: object - $ref: "./roleassignments.yaml#/Domain" - -ServiceV2: - type: object - description: keystone v2服务信息 - properties: - name: - type: string - description: 服务名称 - type: - type: string - description: 服务类型 - endpoints: - type: array - description: 接入点列表 - items: - type: object - $ref: '#/EndpointV2' - -EndpointV2: - type: object - description: keystone v2接入点信息 - properties: - id: - type: string - description: 接入点ID - region: - type: string - description: 区域ID - internal_url: - type: string - description: internal url - public_url: - type: string - description: public url - admin_url: - type: string - description: admin url - -Auth3Input: - type: object - description: keystone v3认证请求 - properties: - identity: - type: object - description: 认证信息 - $ref: '#/AuthIdentity3' - scope: - type: object - description: 认证scope - $ref: './roleassignments.yaml#/Scope' - context: - type: object - $ref: '#/AuthContext' - -AuthIdentity3: - type: object - description: keystone v3认证鉴权信息 - properties: - methods: - type: array - description: 认证方式列表 - items: - type: string - description: 认证方式, 可能值为password, token - password: - type: object - description: 密码认证信息 - properties: - id: - type: string - description: 用户ID - name: - type: string - description: 用户名称 - password: - type: string - description: 密码 - domain: - type: object - $ref: "./roleassignments.yaml#/Domain" - token: - type: object - description: token认证信息 - properties: - id: - type: string - description: tokenID - -Auth3Response: - type: object - description: keystone v3认证响应 - properties: - token: - type: object - $ref: '#/TokenV3' - -TokenV3: - type: object - description: keystone v3 token - properties: - audit_ids: - type: array - items: - type: string - description: AuditIds - expires_at: - type: string - format: date-time - description: token过期时间 - is_domain: - type: boolean - description: 是否为domain的token - issued_at: - type: string - format: date-time - description: token发放时间 - methods: - type: array - items: - type: string - description: 请求的methods - project: - type: object - $ref: './roleassignments.yaml#/DomainObject' - roles: - type: array - items: - type: object - $ref: './roleassignments.yaml#/DomainObject' - user: - type: object - properties: - id: - type: string - description: 用户ID - name: - type: string - description: 用户名称 - displayname: - type: string - description: 用户显示名称 - email: - type: string - description: 用户的电子邮箱 - mobile: - type: string - description: 用户的手机号 - domain: - type: object - description: 资源归属的域信息 - $ref: './roleassignments.yaml#/Domain' - policies: - type: object - $ref: './roleassignments.yaml#/PolicyObject' - projects: - type: array - items: - $ref: './roleassignments.yaml#/DomainObject' - role_assignments: - type: array - items: - $ref: './roleassignments.yaml#/RoleAssignment' - catalog: - type: array - items: - type: object - $ref: '#/ServiceV3' - context: - type: object - $ref: '#/AuthContext' - -ServiceV3: - type: object - decription: keystone V3 service - properties: - id: - type: string - description: 服务ID - name: - type: string - description: 服务名称 - type: - type: string - description: 服务类型 - endpoints: - type: array - description: keystone V3 endpoint - items: - type: object - $ref: '#/EndpointV3' - -EndpointV3: - type: object - description: keystone V3 endpoint - properties: - id: - type: string - description: endpoint ID - interface: - type: string - description: endpoint类型, 可能值为：internal, public, admin, console - region: - type: string - description: endpoint所在区域名称 - region_id: - type: string - description: endpoint所在区域ID - url: - type: string - description: endpoint URL - name: - type: string - description: endpoint name diff --git a/docs/schemas/bucket.yaml b/docs/schemas/bucket.yaml deleted file mode 100644 index c2319d55cf..0000000000 --- a/docs/schemas/bucket.yaml +++ /dev/null @@ -1,235 +0,0 @@ -BucketListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - buckets: - type: array - items: - $ref: "#/Bucket" - -BucketObjectListResponse: - type: object - properties: - bucket: - type: object - properties: - objects: - type: array - items: - $ref: '#/BucketObject' - -BucketObject: - type: object - properties: - key: - type: string - description: 对象的key, 如果key以"/"结尾，则该key一般是目录占位对象 - size_bytes: - type: integer - description: 对象大小 - last_modified: - type: string - description: 该对象的最近修改时间 - etag: - type: string - description: 该对象的md5 checksum - storage_class: - type: string - description: 该对象的存储等级字符串 - -BucketGetResponse: - type: object - properties: - bucket: - type: object - $ref: "#/Bucket" - -BucketPutRequestInput: - type: object - properties: - name: - type: string - description: 存储桶的名称 - description: - type: string - description: 存储桶的描述 - -BucketCreateInput: - type: object - properties: - name: - type: string - required: true - description: 存储桶的名称 - cloudregion: - type: string - required: true - description: 存储桶所在cloudregion的名称或ID，对于on premise的通用s3存储，cloudregion为default - manager: - type: string - required: true - description: 存储桶归属的账号订阅(cloudprovider)的名称或ID - storage_class: - type: string - description: 存储桶的存储类型，可能值为：standard, ia和archive - description: - type: string - description: 存储桶的描述 - -Bucket: - type: object - description: 存储桶的描述信息 - properties: - id: - type: string - description: 存储桶的ID - readOnly: true - name: - type: string - description: 对象存储桶的名称，全局唯一。并且名字唯一性受到所在云供应商的桶名字空间唯一性的约束。 - can_delete: - type: boolean - description: 是否可以删除 - acl: - type: string - description: 存储桶的默认访问权限，可能值为：private, public-read和public-read-write - storage_class: - type: string - description: 存储桶的默认存储类型 - access_urls: - type: object - description: 存储桶的访问URL信息 - object_cnt: - type: integer - description: 对象总数量 - object_cnt_limit: - type: integer - description: 该bucket允许的最大对象数，为0则无对象数限制 - size_bytes: - type: integer - description: 对象的总大小(bytes) - size_bytes_limit: - type: integer - description: 该bucket允许的最大容量，为0则无容量限制 - tenant_id: - type: string - description: 存储桶归属的项目ID - domain_id: - type: string - description: 存储桶归属的项目的域ID - location: - type: string - description: 存储桶的所在区域信息 - account_id: - type: string - description: 存储桶的云账号的ID - -BucketObjectDeleteInput: - type: object - properties: - keys: - type: array - items: - type: string - description: 待删除的对象Key - -BucketObjectDeleteResponse: - type: object - properties: - bucket: - type: array - items: - $ref: "" - -BucketObjectDeleteInfo: - type: object - properties: - id: - type: string - description: 对象key - status: - type: integer - description: 删除结果，200为成功，400为失败 - data: - type: string - description: 如果status为400，则data为错误原因 - -BucketObjectTempUrlInput: - type: object - properties: - key: - type: string - description: 对象key - method: - type: string - description: 请求对象的HTTP方法，例如：GET|PUT|DELETE - expire_seconds: - type: integer - description: 该临时URL的超时时间，单位为秒 - -BucketObjectTempUrlResponse: - type: object - properties: - bucket: - type: object - properties: - url: - type: string - description: 生成的临时URL - -BucketGetACLResponse: - type: object - properties: - bucket: - type: object - properties: - acl: - type: string - description: bucket或者对象的ACL字串，可能为private, public-read, public-read-write, authenticated-read - -BucketMakedirInput: - type: object - properties: - key: - type: string - description: 目录的名称，必需以"/"结尾 - -BucketSetACLInput: - type: object - properties: - acl: - type: string - required: true - description: bucket或者对象的ACL字串，可能为private, public-read, public-read-write - key: - type: string - description: 如果设置对象的ACL，则此字段指定对象的key - -BucketSetLimitInput: - type: object - properties: - limit: - type: object - description: 桶的存储限制 - properties: - size_bytes: - type: integer - description: 容量上限，为0则无限制 - object_count: - type: integer - description: 对象数量限制，为0则无限制 - -BucketAccessInfoResponse: - type: object - properties: - bucket: - type: object - description: 桶的后端访问信息，例如ceph RADOS的endpoint/access_key/secret信息等。具体形式由存储后端决定。 diff --git a/docs/schemas/cloudaccount.yaml b/docs/schemas/cloudaccount.yaml deleted file mode 100644 index 2a4b750d98..0000000000 --- a/docs/schemas/cloudaccount.yaml +++ /dev/null @@ -1,292 +0,0 @@ -CloudaccountCreate: - type: object - properties: - name: - type: string - example: test-account - required: true - description: 云账号名称 - description: - type: string - example: account-description - description: 云账号描述 - provider: - type: string - example: Aliyun - enum: [VMware,Aliyun,Qcloud,Azure,Aws,Huawei,OpenStack,Ucloud,ZStack,S3] - description: 云账号平台 - brand: - type: string - example: DStack - enum: [DStack] - description: 私有云品牌 - sync_interval_seconds: - type: integer - example: 3600 - description: 自动同步间隔时间 - auto_create_project: - type: boolean - example: false - default: false - description: 自动在本地创建纳管云上的项目 - access_key_id: - type: string - example: LTAI5H1wXkXeasMB - description: 秘钥ID(阿里云, AWS, 华为, UCloud,S3) - access_key_secret: - type: string - example: cByPBQM3zFVgNBMKEJLMYrKFUovVk8 - description: 秘钥Key(阿里云, AWS， 华为, UCloud,S3) - client_id: - type: string - example: 0ed6d723-aea3-4034-824f-c13805690827 - description: 客户端ID(Azure) - client_secret: - type: string - example: 7Q1rK+5D3GVrqkSsdggf06BsYZj6RihHn43+yk8gRc= - description: 客户端密码(Azure) - username: - type: string - example: root - description: 登录用户名(Esxi,OpenStack,ZStack) - password: - type: string - example: test-password - description: 登录密码(Esxi,OpenStack,ZStack) - project_name: - type: string - example: admin - description: 项目名(OpenStack) - domain_name: - type: string - example: Default - description: 域名称(OpenStack) - secret_id: - type: string - example: AKID6QtjkcXtc5eJJSMfMbXVuJVT4UESk6tdv - description: 秘钥ID(腾讯云) - secret_key: - type: string - example: C9rKdiYIn340iIJdokgQwCF3kCPTKxLWSG - description: 秘钥Key(腾讯云) - environment: - type: string - example: AzureChinaCloud - enum: [AzureChinaCloud,AzurePublicCloud,ChinaCloud] - description: 账号环境(Aws,Azure,Huawei) - host: - type: string - example: 192.168.222.203 - description: 环境IP(Esxi) - port: - type: integer - example: 443 - description: 环境端口(Esxi) - endpoint: - type: string - description: 端点地址(S3) - auth_url: - type: string - example: http://192.168.222.203:5000/v3 - description: 认证地址(OpenStack,ZStack) - app_id: - type: string - example: 123134442 - description: 腾讯云专有的app_id - tenant: - type: string - example: system - description: 项目ID或名称,指定此参数后子账号将归属于指定的项目,优先级高于auto_create_project参数 - - -CloudaccountResponse: - type: object - properties: - cloudaccount: - type: object - $ref: '#/Cloudaccount' - -Cloudaccount: - allOf: - - $ref: "./common.yaml#/EnabledStatusStandaloneResponse" - - type: object - properties: - access_url: - type: string - example: http://test.host.com:8080 - description: 云账号连接地址或云账号所属区域信息 - account: - type: string - example: LTAI5H1wXkXeasMB - description: 云账号access id或密码 - secret: - type: string - example: ST4AeRZjRISJ8t4v0Qm22/nUMjVTZXBuGl/P2UkcupY62sD1XKNGSwp2vLNaNTsnvaGc8cZithY= - description: 云账号加密后的密码 - is_public_cloud: - type: boolean - example: true - description: 是否是公有云账号 - is_on_premise: - type: boolean - example: false - description: 是否是 one_premise - provider: - type: stirng - example: Aliyun - description: 云账号平台 - enable_auto_sync: - type: boolean - example: true - description: 是否开启自动同步 - sync_interval_seconds: - type: integer - example: 3600 - description: 自动同步间隔时间 - balance: - type: integer - example: 66.01 - description: 账号余额 - prob_at: - type: string - example: “2019-08-01T06:53:46.000000Z” - description: 上传检查账号状态时间 - health_status: - type: string - example: normal - enum: [normal, insufficient, suspended, arrears, unknown, no permission] - description: 账号健康状态，normal->正常, insufficient->余额不足, suspended->账号冻结, arrears->欠费, unknown->未知, no permission->无权限获取余额 - error_count: - type: integer - example: 0 - description: 账号连接错误次数 - auto_create_project: - type: boolean - example: false - default: false - description: 自动创建和云上项目同名的本地项目 - brand: - type: string - example: DStack - description: 私有云品牌信息 - sync_status: - type: string - example: idle - description: 云账号同步状态 - last_sync: - type: string - example: ”2019-07-30T11:26:40.000000Z“ - description: 上次同步时间 - last_sync_end_at: - type: string - example: "2019-08-01T07:53:46.000000Z" - description: 上次同步完成时间 - -CloudaccountListResponse: - type: object - properties: - limit: - type: integer - example: 20 - cloudaccounts: - type: array - items: - $ref: '#/Cloudaccount' - total: - type: integer - example: 124 - -CloudaccountUpdate: - type: object - properties: - name: - type: string - example: test-account - description: 云账号名称 - description: - type: string - example: account-description - description: 云账号描述 - - -CloudaccountSync: - type: object - properties: - full_sync: - type: boolean - example: true - description: 是否全量同步 - region: - type: string - example: a53adc31-7601-4ddf-8874-93639f5626db - description: 指定同步区域 - zone: - type: string - example: 0ed6d723-aea3-4034-824f-c13805690827 - description: 指定同步zone - host: - type: string - example: 0ed6d723-aea3-4034-824f-c13805690827 - description: 指定同步host - - -CloudaccountUpdateCredential: - type: object - properties: - access_key_id: - type: string - example: LTAI5H1wXkXeasMB - description: 秘钥ID(阿里云, AWS, 华为, UCloud,S3) - access_key_secret: - type: string - example: cByPBQM3zFVgNBMKEJLMYrKFUovVk8 - description: 秘钥Key(阿里云, AWS， 华为, UCloud,S3) - client_id: - type: string - example: 0ed6d723-aea3-4034-824f-c13805690827 - description: 客户端ID(Azure) - client_secret: - type: string - example: 7Q1rK+5D3GVrqkSsdggf06BsYZj6RihHn43+yk8gRc= - description: 客户端密码(Azure) - username: - type: string - example: root - description: 登录用户名(Esxi,OpenStack,ZStack) - password: - type: string - example: test-password - description: 登录密码(Esxi,OpenStack,ZStack) - project_name: - type: string - example: admin - description: 项目名(OpenStack) - domain_name: - type: string - example: Default - description: 域名称(OpenStack) - secret_id: - type: string - example: AKID6QtjkcXtc5eJJSMfMbXVuJVT4UESk6tdv - description: 秘钥ID(腾讯云) - secret_key: - type: string - example: C9rKdiYIn340iIJdokgQwCF3kCPTKxLWSG - description: 秘钥Key(腾讯云) - -CloudaccountChangeProject: - type: object - properties: - project: - type: string - example: 7aaf3e6c-5f9c-43ad-b149-d9a14765af1c - description: 项目名称或ID - - -CloudaccountEnableAutoSync: - type: object - properties: - sync_interval_seconds: - type: integer - example: 3600 - description: 云账号自动同步间隔时间 diff --git a/docs/schemas/common.yaml b/docs/schemas/common.yaml deleted file mode 100644 index 805cd8227c..0000000000 --- a/docs/schemas/common.yaml +++ /dev/null @@ -1,212 +0,0 @@ -ResourceBaseResponse: - type: object - properties: - created_at: - type: string - example: "2019-06-10T03:39:02.000000Z" - description: 创建时间 - readOnly: true - updated_at: - type: string - example: "2019-06-11T03:39:02.000000Z" - description: 更新时间 - readOnly: true - deleted_at: - type: string - example: "2019-06-12T03:39:02.000000Z" - description: 删除时间 - readOnly: true - deleted: - type: boolean - example: true - description: 已删除 - readOnly: true - -ManagedResourceBaseResponse: - type: object - properties: - managed_id: - type: string - example: 3209e9b5-c32a-4e4d-84e5-650d7ecb9d8e - description: 子订阅ID - readOnly: true - -CloudregionResourceBaseResponse: - type: object - properties: - cloudregion_id: - type: string - example: 5fbbdfaa-46ba-433a-81be-b3581ac55bfa - description: 区域ID - cloudregion: - type: string - example: 阿里云 马来西亚（吉隆坡） - description: 区域名称 - - -ZoneResourceBaseResponse: - type: object - properties: - zone_id: - type: string - example: d0e8d9c2-a21d-447e-8984-50838f4cd3fa - description: 可用区区域ID - zone: - type: string - example: 阿里云 中东东部1 可用区A - description: 可用区域名称 - - -BillingResourceBaseResponse: - type: object - properties: - billing_type: - type: string - example: prepaid - default: postpaid - description: 计费类型, 预付费、后付费 - expired_at: - type: string - example: "2019-12-17T16:00:00.000000Z" - description: 到期时间 - readOnly: true - -ProjectizedResourceBaseResponse: - type: object - properties: - project_id: - type: string - example: cb58813d83284a7f95040901639013d3 - description: 资源所属项目ID - readOnly: true - domain_id: - type: string - example: 9c06c2082007459f81b6e355eedf22fd - description: 资源所属域ID - readOnly: true - -ExternalizedResourceBaseResponse: - type: object - properties: - external_id: - type: string - example: "i-7948b8d96f" - description: 资源External ID - readOnly: true - -StandaloneResponse: - allOf: - - $ref: '#/ResourceBaseResponse' - - type: object - properties: - id: - type: string - example: fc06c2082007459f81b6e355eedf22fd - description: 资源ID - readOnly: true - name: - type: string - example: webserver - description: 资源名称 - readOnly: true - description: - type: string - example: onecloud webserver - description: 资源描述 - readOnly: true - -StatusStandaloneResponse: - allOf: - - $ref: '#/StandaloneResponse' - - type: object - properties: - status: - type: string - example: running - description: 资源状态 - readOnly: true - -EnabledStatusStandaloneResponse: - allOf: - - $ref: './common.yaml#/StatusStandaloneResponse' - - type: object - properties: - enabled: - type: boolean - example: true - desciption: 资源是否启用 - readOnly: false - -VirtualResourceBaseResponse: - allOf: - - $ref: '#/StatusStandaloneResponse' - - $ref: '#/ProjectizedResourceBaseResponse' - - type: object - properties: - project_src: - type: string - example: local - description: 资源Src - readOnly: true - is_system: - type: boolean - description: 系统资源 - readOnly: true - -SharableVirtualResourceBaseResponse: - allOf: - - $ref: '#/VirtualResourceBaseResponse' - - $ref: '#/ProjectizedResourceBaseResponse' - - type: object - properties: - is_public: - type: boolean - description: Is Public? - readOnly: true - public_scope: - type: string - example: system - description: public_scope - readOnly: true - -BillingBaseResponse: - type: object - properties: - billing_type: - type: string - example: postpaid - enum: [postpaid, prepaid] - description: 资源计费类型 - expired_at: - type: string - example: "2019-06-11T03:39:02.000000Z" - description: 资源到期时间,仅对预付费类型资源有效 - -ProviderBaseResponse: - type: object - properties: - region_id: - type: string - example: 5fbbdfaa-46ba-433a-81be-b3581ac55bfa - description: 区域ID - region_external_id: - type: string - example: 5fbbdfaa-46ba-433a-81be-b3581ac55bfa - description: 区域云端ID - region: - type: string - example: 阿里云 马来西亚（吉隆坡） - description: 区域名称 - project_domain: - type: string - example: Default - description: 项目 - manager: - type: string - example: Default - description: 云账号 - manager_id: - type: string - example: 7b972be9-fd8a-43f5-8058-3820553f61c4 - description: 云账号ID - \ No newline at end of file diff --git a/docs/schemas/credential.yaml b/docs/schemas/credential.yaml deleted file mode 100644 index 7a69d7a204..0000000000 --- a/docs/schemas/credential.yaml +++ /dev/null @@ -1,50 +0,0 @@ -CredentialListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - credentials: - type: array - items: - $ref: "#/Credential" - -CredentialGetResponse: - type: object - properties: - credential: - type: object - $ref: "#/Credential" - -Credential: - type: object - description: 用户Credentials - properties: - id: - type: string - description: 用户CredentialID - readOnly: true - name: - type: string - description: 用户Credential名称，域内唯一 - type: - type: string - description: 用户Credential类型，totp或者recovery_secret - can_delete: - type: boolean - description: 是否可以删除 - blob: - type: string - description: 用户Credential内容，json字符串 - user_id: - type: string - description: Credential的所属用户 - project_id: - type: string - description: Credential的所属项目 diff --git a/docs/schemas/dbinstance.yaml b/docs/schemas/dbinstance.yaml deleted file mode 100644 index ed259a4782..0000000000 --- a/docs/schemas/dbinstance.yaml +++ /dev/null @@ -1,250 +0,0 @@ -DBInstance: - allOf: - - $ref: "./common.yaml#/VirtualResourceBaseResponse" - - $ref: "./common.yaml#/BillingResourceBaseResponse" - - $ref: "./common.yaml#/ManagedResourceBaseResponse" - - $ref: "./common.yaml#/CloudregionResourceBaseResponse" - - $ref: "./common.yaml#/ZoneResourceBaseResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: RDS实例 - properties: - disk_size_gb: - type: integer - example: 20 - description: RDS实例存储大小 - storage_type: - type: string - example: cloud_essd - description: RDS实例存储类型 - engine: - type: string - example: MySQL - description: RDS实例引擎 - readOnly: true - engine_version: - type: string - example: "5.7" - description: RDS实例引擎版本 - instance_type: - type: string - example: mysql.n1.micro.1 - description: RDS实例规格 - category: - type: string - example: basic - description: RDS实例高可用类型 - port: - type: integer - example: 3306 - description: RDS实例连接端口 - vcpu_count: - type: integer - example: 1 - description: RDS实例CPU核数 - vmem_size_mb: - type: integer - example: 1024 - description: RDS实例内存大小 - vpc_id: - type: string - example: 5d0a3589-4ec5-4509-8e53-6505457577b0 - description: RDS实例VPC ID - vpc: - type: string - example: vpc-2zecuo9v4idebme295ofy - description: RDS实例VPC ID - disable_delete: - type: boolean - example: true - description: 是否锁定(删除保护) - connection_str: - type: string - example: rm-2zeyj104t2b0c2270mo.mysql.rds.aliyuncs.com - description: 外网连接地址 - internal_connection_str: - type: string - example: fsdghello.mysql.rds.aliyuncs.com - description: 内网连接地址 - secgroup_id: - type: string - example: 318e8b0e-c392-4ac2-8562-40303f79a5c9 - description: 安全组id - secgroup: - type: string - example: Default - description: 安全组名称 - iops: - type: integer - example: 500 - description: IOPS大小 - -DBInstanceListResponse: - type: object - properties: - limit: - type: integer - example: 20 - dbinstances: - type: array - items: - $ref: '#/DBInstance' - total: - type: integer - example: 124 - -DBInstanceResponse: - type: object - properties: - dbinstance: - type: object - $ref: '#/DBInstance' - - -DBInstanceCreate: - type: object - properties: - zone1: - type: string - example: test-zone - description: 可用区1名称或ID - zone2: - type: string - example: test-zone - description: 可用区2名称或ID - zone3: - type: string - example: test-zone - description: 可用区3名称或ID - network: - type: string - example: test-network - required: true - description: IP子网ID或名称 - address: - type: string - example: 10.12.2.12 - description: 内网IP,需要在network网段内 - vcpu_count: - type: integer - example: 1 - description: RDS实例CPU核数 - vmem_size_mb: - type: integer - example: 2 - description: RDS实例内存大小 - storage_type: - type: string - required: true - example: cloud_ssd - enum: [local_ssd, cloud_essd, cloud_ssd] - description: RDS实例存储类型 - disk_size_gb: - type: integer - required: true - example: 30 - description: RDS实例存储大小 - port: - type: integer - example: 3306 - description: RDS实例连接端口 - category: - type: string - example: basic - enum: [basic, high_availability, always_on, finance, single, replica] - description: RDS实例类别(单机、高可用、只读) - engine: - type: string - example: MySQL - description: RDS实例引擎 - engine_version: - type: string - example: 8.0 - description: RDS实例引擎版本 - instance_type: - type: string - example: mysql.n4.large.1 - description: RDS实例规格,若不指定CPU及内存，此参数必填 - duration: - type: string - example: 1m - description: 包年包月时长 - master_instance: - type: string - example: test-master-instance - description: 主RDS实例名称或ID,创建只读实例时需要指定 - secgroup: - type: string - example: test-secgroup - description: 安全组名称或ID - password: - type: string - example: bsnt{Hz{Z3p6 - description: 密码信息 - description: - type: string - example: test-description - description: 描述信息 - disable_delete: - type: boolean - example: true - default: true - description: 是否锁定(删除保护) - - -DBInstanceChangeConfig: - type: object - properties: - instance_type: - type: string - example: mssql.x4.8xlarge.e2 - description: 更换RDS实例规格 - vcpu_count: - type: integer - example: 6 - description: 更改CPU大小 - vmem_size_mb: - type: integer - example: 1024 - description: 更改内存大小 - storage_type: - type: string - example: local_ssd - description: 存储类型 - disk_size_gb: - type: integer - example: 40 - description: 存储磁盘大小 - category: - type: string - example: high_availability - description: 更改实例类型 - -DBInstancePublicConnection: - type: object - properties: - open: - type: boolean - example: true - default: true - description: 关闭或打开外网地址 - -DBInstanceRecovery: - type: object - properties: - databases: - type: object - additionalProperties: - type: string - example: - source-database1: dest-database1 - source-database2: dest-database2 - description: 源数据库名称->目的数据库名称 - description: 数据库列表,为空代表恢复整个备份内容,databases源数据库内容可以从backup的dbnames中获取,目的数据库不可与目标rds实例数据库重复 - dbinstancebackup: - type: string - example: test-backup - required: true - description: 实例备份名称或ID - - diff --git a/docs/schemas/dbinstance_account.yaml b/docs/schemas/dbinstance_account.yaml deleted file mode 100644 index 2193ae4098..0000000000 --- a/docs/schemas/dbinstance_account.yaml +++ /dev/null @@ -1,134 +0,0 @@ -DBInstanceAccountListResponse: - type: object - properties: - limit: - type: integer - example: 20 - dbinstanceaccounts: - type: array - items: - $ref: '#/DBInstanceAccount' - total: - type: integer - example: 124 - -DBInstanceAccountResponse: - type: object - properties: - dbinstanceaccount: - type: object - $ref: '#/DBInstanceAccount' - -DBInstanceAccount: - allOf: - - $ref: "./common.yaml#/StandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - properties: - status: - type: string - example: available - description: RDS实例账号状态 - dbinstanceprivileges: - type: array - items: - $ref: '#/DBInstanceAccountPrivilege' - -DBInstanceAccountPrivilege: - type: object - properties: - database: - type: string - example: hello - description: 数据库名称 - account: - type: string - example: root - description: 账号名称 - dbinstancedatabase_id: - type: string - example: aad86533-a588-4342-8402-a1b11a1a7bf5 - description: 数据库ID - privileges: - type: string - example: ddl - description: 用户对数据库所拥有的权限 - - -DBInstanceAccountCreate: - type: object - properties: - dbinstance: - type: string - example: test-rds - required: true - description: RDS实例名称或ID - name: - type: string - example: test-user - required: true - description: 用户名称 - description: - type: string - example: string - description: 描述信息 - password: - type: string - example: fjs9@33f8 - description: 密码 - privileges: - type: array - items: - $ref: '#/DBInstanceAccountPrivilegeCreate' - -DBInstanceAccountPrivilegeCreate: - type: object - properties: - database: - type: string - example: test-database - description: 数据库名称或ID - privilege: - type: string - example: rw - description: 数据库权限 - -DBInstanceAccountResetPassword: - type: object - properties: - password: - type: string - example: 123@qweASD - description: 重置的账号密码，为空则自动生成 - -DBInstanceAccountGrantPrivilege: - type: object - properties: - database: - type: string - example: test-database - required: true - description: 实例的数据库名称或ID - privilege: - type: string - example: rw - required: true - description: 权限 - -DBInstanceAccountRevokePrivilege: - type: object - properties: - database: - type: string - example: test-database - required: true - description: 实例的数据库名称或ID - -DBInstanceAccountSetPrivileges: - type: object - properties: - privileges: - type: array - items: - $ref: '#/DBInstanceAccountPrivilegeCreate' - diff --git a/docs/schemas/dbinstance_backup.yaml b/docs/schemas/dbinstance_backup.yaml deleted file mode 100644 index af614f1a22..0000000000 --- a/docs/schemas/dbinstance_backup.yaml +++ /dev/null @@ -1,100 +0,0 @@ -DBInstanceBackup: - allOf: - - $ref: "./common.yaml#/StatusStandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: RDS实例参数 - properties: - start_time: - type: string - example: "2019-06-22T02:31:08.000000Z" - description: RDS实例备份开始时间 - end_time: - type: string - example: "2019-06-22T02:33:24.000000Z" - description: RDS实例备份结束时间 - backup_mode: - type: string - example: full_backup - description: RDS实例备份类型，手动或自动 - backup_size_mb: - type: integer - example: 21 - description: 备份大小 - dbinstance_id: - type: string - example: d0fe1519-8de5-4e13-844a-7367f4210f83 - description: RDS实例ID - readOnly: true - dbinstance: - type: string - example: test-rds - description: RDS实例名称 - engine: - type: string - example: MySQL - description: 备份的数据库类型 - engine_version: - type: string - example: 5.6 - description: 北京的数据库版本 - cloudregion_id: - type: string - example: c8b87bc0-fd97-4b28-83ad-2a8f9b755bab - description: RDS备份所属的region id - readOnly: true - region: - type: string - example: 阿里云 北京 - description: RDS备份所在的区域名称 - dbnames: - type: string - example: test-database1,test-database2 - description: 备份包含的数据库列表 - -DBInstanceBackupListResponse: - type: object - properties: - limit: - type: integer - example: 20 - dbinstancebackups: - type: array - items: - $ref: '#/DBInstanceBackup' - total: - type: integer - example: 124 - -DBInstanceBackupResponse: - type: object - properties: - dbinstancebackup: - type: object - $ref: '#/DBInstanceBackup' - -DBInstanceBackupCreate: - type: object - properties: - dbinstance: - type: string - example: test-rds - required: true - description: RDS实例名称或ID - name: - type: string - example: test-backup - required: true - description: 备份名称 - description: - type: string - example: test-description - description: 描述信息 - databases: - type: array - items: - type: string - example: test-database - description: 需要备份的数据库 - - diff --git a/docs/schemas/dbinstance_database.yaml b/docs/schemas/dbinstance_database.yaml deleted file mode 100644 index c45e4d171d..0000000000 --- a/docs/schemas/dbinstance_database.yaml +++ /dev/null @@ -1,103 +0,0 @@ -DBInstanceDatabase: - allOf: - - $ref: "./common.yaml#/StatusStandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: RDS实例数据库 - properties: - character_set: - type: string - example: utf8 - description: RDS数据库字符集 - dbinstance_id: - type: string - example: d0fe1519-8de5-4e13-844a-7367f4210f83 - description: RDS实例ID - readOnly: true - dbinstanceprivileges: - type: array - items: - $ref: '#/DBInstanceAccountPrivilege' - -DBInstanceAccountPrivilege: - type: object - properties: - database: - type: string - example: hello - description: 数据库名称 - account: - type: string - example: root - description: 账号名称 - dbinstancedatabase_id: - type: string - example: aad86533-a588-4342-8402-a1b11a1a7bf5 - description: 数据库ID - privileges: - type: string - example: ddl - description: 用户对数据库所拥有的权限 - - - -DBInstanceDatabaseListResponse: - type: object - properties: - limit: - type: integer - example: 20 - dbinstancedatabases: - type: array - items: - $ref: '#/DBInstanceDatabase' - total: - type: integer - example: 124 - -DBInstanceDatabaseResponse: - type: object - properties: - dbinstancedatabase: - type: object - $ref: '#/DBInstanceDatabase' - -DBInstanceDatabaseCreate: - type: object - properties: - dbinstance: - type: string - example: test-rds - required: true - description: RDS实例名称或ID - name: - type: string - example: test-database - required: true - description: 数据库名称 - description: - type: string - example: test-description - description: 描述信息 - character_set: - type: string - example: utf8 - description: 数据库字符集 - accounts: - type: array - items: - $ref: '#/DBInstanceDatabaseAccountCreate' - -DBInstanceDatabaseAccountCreate: - type: object - properties: - account: - type: string - example: test-user - description: 需要授予权限的账号名称 - privilege: - type: string - example: rw - description: 账号权限 - - diff --git a/docs/schemas/dbinstance_network.yaml b/docs/schemas/dbinstance_network.yaml deleted file mode 100644 index 8374e44b37..0000000000 --- a/docs/schemas/dbinstance_network.yaml +++ /dev/null @@ -1,42 +0,0 @@ -DBInstanceNetwork: - allOf: - - $ref: "./common.yaml#/ResourceBaseResponse" - - type: object - description: RDS实例网络 - properties: - dbinstance_id: - type: string - example: "20f8b552-1b86-4595-89e3-49d123b25215" - description: RDS实例ID - ip_addr: - type: string - example: 10.10.140.141 - description: 实例内网IP地址 - network_id: - type: string - example: "38897a74-17b4-4c21-86b3-4f8528ced003" - description: 实例子网ID - - -DBInstanceNetworkListResponse: - type: object - properties: - limit: - type: integer - example: 20 - dbinstancenetworks: - type: array - items: - $ref: '#/DBInstanceNetwork' - total: - type: integer - example: 124 - -DBInstanceNetworkResponse: - type: object - properties: - dbinstancenetwork: - type: object - $ref: '#/DBInstanceNetwork' - - diff --git a/docs/schemas/dbinstance_parameter.yaml b/docs/schemas/dbinstance_parameter.yaml deleted file mode 100644 index 127bd19503..0000000000 --- a/docs/schemas/dbinstance_parameter.yaml +++ /dev/null @@ -1,44 +0,0 @@ -DBInstanceParameterListResponse: - type: object - properties: - limit: - type: integer - example: 20 - dbinstanceparameters: - type: array - items: - $ref: '#/DBInstanceParameter' - total: - type: integer - example: 124 - -DBInstanceParameterResponse: - type: object - properties: - dbinstanceparameter: - type: object - $ref: '#/DBInstanceParameter' - -DBInstanceParameter: - allOf: - - $ref: "./common.yaml#/StandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: RDS实例参数 - properties: - key: - type: string - example: read_buffer_size - description: RDS实例参数 - value: - type: string - example: "131072" - description: RDS实例参数值 - readOnly: true - dbinstance_id: - type: string - example: d0fe1519-8de5-4e13-844a-7367f4210f83 - description: RDS实例ID - readOnly: true - - diff --git a/docs/schemas/dbinstance_sku.yaml b/docs/schemas/dbinstance_sku.yaml deleted file mode 100644 index aa496a4223..0000000000 --- a/docs/schemas/dbinstance_sku.yaml +++ /dev/null @@ -1,105 +0,0 @@ -DBInstanceSku: - allOf: - - $ref: "./common.yaml#/CloudregionResourceBaseResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: RDS套餐信息 - properties: - disk_size_gb: - type: integer - example: 20 - description: RDS实例存储大小 - storage_type: - type: string - example: cloud_essd - description: RDS实例存储类型 - engine: - type: string - example: MySQL - description: RDS实例引擎 - readOnly: true - engine_version: - type: string - example: "5.7" - description: RDS实例引擎版本 - instance_type: - type: string - example: mysql.n1.micro.1 - description: RDS实例规格 - category: - type: string - example: basic - description: RDS实例高可用类型 - vcpu_count: - type: integer - example: 1 - description: RDS实例CPU核数 - vmem_size_mb: - type: integer - example: 1024 - description: RDS实例内存大小 - iops: - type: integer - example: 9000 - description: iops - max_disk_size_gb: - type: integer - example: 4000 - description: 最大存储大小 - min_disk_size_gb: - type: integer - example: 20 - description: 最小存储大小 - disk_size_step: - type: integer - example: 5 - description: 存储步长,单位GB - provider: - type: string - example: Aliyun - description: 平台 - status: - type: string - example: available - description: 套餐状态 - zone1: - type: string - example: fa39a6af-eafc-43bb-8683-bfdc04d6e18d - description: zone1的ID - zone2: - type: string - example: fa39a6af-eafc-43bb-8683-bfdc04d6e18d - description: zone2的ID - zone3: - type: string - example: fa39a6af-eafc-43bb-8683-bfdc04d6e18d - description: zone3的ID - zone_id: - type: string - example: us-east-1b - description: 公有云套餐zone代码 - - -DBInstanceSkuListResponse: - type: object - properties: - limit: - type: integer - example: 20 - dbinstance_skus: - type: array - items: - $ref: '#/DBInstanceSku' - total: - type: integer - example: 124 - -DBInstanceSkuResponse: - type: object - properties: - dbinstance_sku: - type: object - $ref: '#/DBInstanceSku' - - - diff --git a/docs/schemas/disk.yaml b/docs/schemas/disk.yaml deleted file mode 100644 index 70a978f516..0000000000 --- a/docs/schemas/disk.yaml +++ /dev/null @@ -1,257 +0,0 @@ -Disk: - type: object - description: 磁盘 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 磁盘uuid - readOnly: true - name: - type: string - description: 磁盘名称 - example: disk-r4hilqks - readOnly: true - billing_type: - type: string - description: 计费类型 - example: postpaid - readOnly: true - account: - type: string - example: office-qcloud - description: 所属云账号名称 - account_id: - type: string - description: 所属云账号ID - brand: - type: string - example: DStack - description: 虚拟化品牌 - created_at: - type: string - example: 2019-05-30T02:25:38.000000Z - description: 资源创建时间 - external_id: - type: string - example: disk-r4hilqks - description: 磁盘外部ID，对应的纳管云磁盘ID - pending_deleted: - type: boolean - example: false - description: 是否在回收站 - provider: - type: string - example: Qcloud - description: 纳管云平台 - region: - type: string - example: 腾讯云 华南地区(广州) - description: 区域名称 - region_id: - type: string - example: 13947bd8-569e-4094-8b03-4339c2a8e45b - description: 区域ID - status: - type: string - example: ready - description: 资源状态 - tenant: - type: string - example: system - description: 归属项目名称 - tenant_id: - type: string - example: 29541006ae9148b9bf002fc294218022 - description: 归属项目ID - update_version: - type: integer - example: 2 - description: 资源被更新的次数 - updated_at: - type: string - example: 2019-05-30T06:36:39.000000Z - description: 资源最近一次更新时间 - zone: - type: string - example: 腾讯云 广州三区 - description: 可用区名称 - zone_ext_id: - type: string - example: ap-guangzhou-3 - description: 可用区外部ID,对应纳管云可用区ID - zone_id: - type: string - example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0efc - description: 可用区ID - disk_format: - type: string - example: qcow2 - description: 磁盘类型qcow2, vmdk， vhd等 - disk_size: - type: integer - example: 10240 - description: 磁盘大小，单位MB - access_path: - type: string - example: /opt/cloud/workspace/disks/a16d3e0b-3fd6-45ec-8b2d-e51a51fa0eff - description: 磁盘存储的路径 - template_id: - type: string - example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0edd - description: 磁盘所用镜像ID - snapshot_id: - type: string - example: a16d3e0b-3fd6-45ec-8b2d-e51a51faccdd - description: 磁盘所用快照ID - fs_format: - type: string - example: ext3 - description: 磁盘分区类型 - disk_type: - type: string - example: system - description: 磁盘类型，系统盘，数据盘和交换分区 - -DiskResponse: - type: object - properties: - disk: - type: object - $ref: '#/Disk' - -DiskListResponse: - type: object - properties: - limit: - type: integer - example: 20 - disks: - type: array - items: - $ref: '#/Disk' - total: - type: integer - example: 124 - -DiskUpdate: - type: object - properties: - name: - type: string - example: other-name - desc: - type: string - description: desc of this disk - auto_delete: - type: string - enum: [enable, disable] - disk_type: - type: string - enum: [data, volume] - -DiskResize: - type: object - properties: - size: - type: integer - example: 20G - description: 扩容后磁盘大小 - -DiskSave: - type: object - properties: - name: - type: string - example: centos - description: 镜像名称 - public: - type: boolean - example: true - description: 是否共享 - format: - type: string - example: qcow2 - enum: [vmdk, qocw2] - description: 镜像格式 - notes: - type: string - description: notes about the image - os_type: - type: object - $ref: "#/OsType" - -OsType: - type: object - properties: - properties: - type: string - enum: [Linux,Windows,VMware] - description: 镜像操作系统类型 - -DiskReset: - type: object - required: [snapshot_id] - properties: - auto_start: - type: boolean - description: 回滚磁盘后自动启动虚拟机 - snapshot_id: - type: string - description: 要回滚的快照Id - -DiskCreate: - type: object - properties: - prefer_region: - type: string - example: Default - description: 区域名称或ID(指定调度区域，若此区域资源不足会导致磁盘创建失败) - prefer_zone: - type: string - example: Zone-1 - description: 可用区名称或ID(指定调度可用区，若此可用区资源不足会导致磁盘创建失败,此优先级高于prefer_region) - prefer_host: - type: string - example: e621b7c6-cb38-48a3-81bd-1f3a9cc07161 - description: 宿主机名称或ID(指定调度宿主机，若宿主机上资源不足会导致磁盘创建失败,此优先级高于prefer_zone) - prefix_wire: - type: string - example: 572f250d-5a68-4471-8c1a-02568c7920fb - description: 二层网络名称或ID(指定关联的二层网络,优先级高于prefer_zone) - name: - type: string - example: test-disk - description: 磁盘名称 - hypervisor: - type: string - example: qcloud - enum: [kvm,esxi,baremetal,container,aliyun,azure,qcloud,aws,huawei,openstack,ucloud,zstack] - description: 指定创建磁盘平台 - size: - type: integer - example: 10240 - description: disk size 单位MB - fs: - type: string - example: ext4 - description: 磁盘分区格式 - format: - type: string - example: qcow2 - description: 磁盘格式 - driver: - type: string - example: scsi - description: 磁盘驱动类型 - backend: - type: string - example: local - description: 存储格式 - -DiskCreateSanpshot: - type: object - properties: - name: - type: string - description: snapshot name diff --git a/docs/schemas/domain.yaml b/docs/schemas/domain.yaml deleted file mode 100644 index a7a5c044d7..0000000000 --- a/docs/schemas/domain.yaml +++ /dev/null @@ -1,71 +0,0 @@ -DomainListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - domains: - type: array - items: - $ref: "#/Domain" - -DomainGetResponse: - type: object - properties: - domain: - type: object - $ref: "#/Domain" - -DomainPutRequestInput: - type: object - properties: - name: - type: string - description: 域的名称 - description: - type: string - description: 域的描述 - -DomainCreateInput: - type: object - properties: - name: - type: string - required: true - description: 域的名称 - description: - type: string - description: 域的描述 - -Domain: - type: object - description: 域 - properties: - id: - type: string - description: 域ID - readOnly: true - name: - type: string - description: 域名称 - can_delete: - type: boolean - description: 是否可以删除 - idp_id: - type: string - description: 如果该域为从认证源导入，则idp_id为该认证源的ID - idp: - type: string - description: 如果该域为从认证源导入，则idp为该认证源的name - idp_driver: - type: string - description: 如果该域为从认证源导入，则idp_driver为该认证源的driver - idp_entity_id: - type: string - description: 如果该域为从认证源导入，则idp_entity_id为该域对应资源的原始ID diff --git a/docs/schemas/elasticcache.yaml b/docs/schemas/elasticcache.yaml deleted file mode 100644 index 22acc7dd91..0000000000 --- a/docs/schemas/elasticcache.yaml +++ /dev/null @@ -1,626 +0,0 @@ -ElasticCache: - allOf: - - $ref: "./common.yaml#/VirtualResourceBaseResponse" - - $ref: "./common.yaml#/BillingResourceBaseResponse" - - $ref: "./common.yaml#/ManagedResourceBaseResponse" - - $ref: "./common.yaml#/ProviderBaseResponse" - - $ref: "./common.yaml#/ZoneResourceBaseResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: ElasticCache实例 - properties: - engine: - type: string - example: Redis - description: ElasticCache实例引擎 - readOnly: true - engine_version: - type: string - example: "3.0" - description: ElasticCache实例引擎版本 - instance_type: - type: string - example: redis.master.micro.default - description: ElasticCache实例规格 - arch_type: - type: string - example: cluster - description: ElasticCache实例架构类型 - network_id: - type: string - example: 39326a92-8691-49e9-886a-097125c48067 - description: ElasticCache实例子网ID - vcpu_count: - type: integer - example: 1 - description: ElasticCache实例CPU核数 - capacity_mb: - type: integer - example: 1024 - description: ElasticCache实例内存大小 - vpc_id: - type: string - example: 5d0a3589-4ec5-4509-8e53-6505457577b0 - description: ElasticCache实例VPC ID - vpc: - type: string - example: vpc-2zecuo9v4idebme295ofy - description: ElasticCache实例VPC ID - private_connect_port: - type: integer - example: 6379 - description: ElasticCache实例内网端口 - private_ip_addr: - type: string - example: 192.168.0.100 - description: ElasticCache实例内网IP - private_dns: - type: string - example: redisx.aliyuncs.com - description: ElasticCache实例内网域名 - public_connect_port: - type: integer - example: 6379 - description: ElasticCache实例公网端口 - public_ip_addr: - type: string - example: 192.168.0.100 - description: ElasticCache实例公网IP - public_dns: - type: string - example: redisx.aliyuncs.com - description: ElasticCache实例公网域名 - maintain_start_time: - type: string - example: 00:00Z - description: ElasticCache实例维护开始时间 - maintain_end_time: - type: string - example: 02:00Z - description: ElasticCache实例维护结束时间 - -ElasticCacheListResponse: - type: object - properties: - limit: - type: integer - example: 20 - elasticcaches: - type: array - items: - $ref: "#/ElasticCache" - total: - type: integer - example: 124 - -ElasticCacheResponse: - type: object - properties: - elasticcache: - type: object - $ref: "#/ElasticCache" - -ElasticCacheNetwork: - allOf: - - $ref: "./common.yaml#/ResourceBaseResponse" - - type: object - description: ElasticCache实例网络 - properties: - elasticcache_id: - type: string - example: "20f8b552-1b86-4595-89e3-49d123b25215" - description: ElasticCache实例ID - ip_addr: - type: string - example: 10.10.140.141 - description: 实例内网IP地址 - network_id: - type: string - example: "38897a74-17b4-4c21-86b3-4f8528ced003" - description: 实例子网ID - -ElasticCacheNetworkListResponse: - type: object - properties: - limit: - type: integer - example: 20 - elasticcachenetworks: - type: array - items: - $ref: "#/ElasticCacheNetwork" - total: - type: integer - example: 124 - -ElasticCacheNetworkResponse: - type: object - properties: - elasticcachenetwork: - type: object - $ref: "#/ElasticCacheNetwork" - -ElasticCacheParameter: - allOf: - - $ref: "./common.yaml#/StandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: ElasticCache实例参数 - properties: - key: - type: string - example: read_buffer_size - description: ElasticCache实例参数 - value: - type: string - example: "131072" - description: ElasticCache实例参数值 - readOnly: true - force_restart: - type: boolean - example: false - description: 重启生效, True（重启生效）/False - readOnly: true - modifiable: - type: boolean - example: false - description: 参数可修改, True（可修改）/False(不可修改) - readOnly: true - -ElasticCacheParameterListResponse: - type: object - properties: - limit: - type: integer - example: 20 - elasticcacheparameters: - type: array - items: - $ref: "#/ElasticCacheParameter" - total: - type: integer - example: 124 - -ElasticCacheParameterResponse: - type: object - properties: - elasticcacheparameter: - type: object - $ref: "#/ElasticCacheParameter" - -ElasticCacheAcl: - allOf: - - $ref: "./common.yaml#/StatusStandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: ElasticCache实例访问控制参数 - properties: - Name: - type: string - example: web_acl - description: ElasticCache实例访问控制Name参数 - IpList: - type: string - example: 192.168.0.1,192.168.0.2 - description: ElasticCache实例访问控制IpList参数 - elasticcache_id: - type: string - example: d0fe1519-8de5-4e13-844a-7367f4210f83 - description: ElasticCache实例ID - readOnly: true - -ElasticCacheAclListResponse: - type: object - properties: - limit: - type: integer - example: 20 - elasticcacheacls: - type: array - items: - $ref: "#/ElasticCacheAcl" - total: - type: integer - example: 124 - -ElasticCacheAclResponse: - type: object - properties: - elasticcacheacl: - type: object - $ref: "#/ElasticCacheAcl" - -ElasticCacheBackup: - allOf: - - $ref: "./common.yaml#/StatusStandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: ElasticCache实例备份参数 - properties: - start_time: - type: string - example: "2019-06-22T02:31:08.000000Z" - description: ElasticCache实例备份开始时间 - end_time: - type: string - example: "2019-06-22T02:33:24.000000Z" - description: ElasticCache实例备份结束时间 - backup_type: - type: string - example: full_backup - description: ElasticCache实例备份类型， 全量|增量额 - backup_mode: - type: string - example: manual - description: ElasticCache实例备份类型， 自动|手动 - backup_size_mb: - type: integer - example: 21 - description: 备份大小 - elasticcache_id: - type: string - example: d0fe1519-8de5-4e13-844a-7367f4210f83 - description: ElasticCache实例ID - readOnly: true - download_url: - type: string - example: redisx.aliyuncs.com/redis.bak - description: ElasticCache备份下载链接 - readOnly: true - -ElasticCacheBackupListResponse: - type: object - properties: - limit: - type: integer - example: 20 - elasticcachebackups: - type: array - items: - $ref: "#/ElasticCacheBackup" - total: - type: integer - example: 124 - -ElasticCacheBackupResponse: - type: object - properties: - elasticcachebackup: - type: object - $ref: "#/ElasticCacheBackup" - -ElasticCacheAccount: - allOf: - - $ref: "./common.yaml#/StandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: ElasticCache实例账号参数 - properties: - password: - type: string - example: abcFFFssx - description: 账号密码 - account_privilege: - type: string - example: read - description: 账号权限 read | write | repl（复制, 复制权限支持读写，且开放SYNC/PSYNC命令） - account_type: - type: string - example: normal - description: 账号类型 normal |admin - elasticcache_id: - type: string - example: d0fe1519-8de5-4e13-844a-7367f4210f83 - description: ElasticCache实例ID - readOnly: true - -ElasticCacheAccountListResponse: - type: object - properties: - limit: - type: integer - example: 20 - elasticcacheaccounts: - type: array - items: - $ref: "#/ElasticCacheAccount" - total: - type: integer - example: 124 - -ElasticCacheAccountResponse: - type: object - properties: - elasticcacheaccount: - type: object - $ref: "#/ElasticCacheAccount" - -ElasticCacheSku: - allOf: - - $ref: "./common.yaml#/StandaloneResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - description: ElasticCache实例套餐信息 - properties: - cloudregion_id: - type: string - example: 2c328dbb-dc40-41f0-8fbd-20a0cbe1829b - description: 实例所在区域ID - engine: - type: string - example: redis - description: 实例引擎 - engine_arch: - type: string - example: cluster - description: 实例架构 - engine_version: - type: string - example: "2.8" - description: 实例版本 - readOnly: true - id: - type: string - example: de76d65b-6134-4945-8ce7-0789d37b5072 - description: 实例ID - readOnly: true - instance_spec: - type: string - example: redis.sharding.basic.small.defaut - description: 实例规格 - readOnly: true - name: - type: string - example: redis.sharding.basic.small.default:v2.8 - description: 实例规格名称 - readOnly: true - local_category: - type: string - example: cluster - description: 实例在Onecloud中所属类别 - readOnly: true - memory_size_mb: - type: integer - example: 16384 - description: 实例内存大小MB - readOnly: true - postpaid_status: - type: string - example: available - description: 实例按需付费可用状态 available|soldout - readOnly: true - prepaid_status: - type: string - example: available - description: 实例预付费可用状态 available|soldout - readOnly: true - provider: - type: string - example: Aliyun - description: 实例Provider - readOnly: true - zone_id: - type: string - example: Aliyun - description: 实例所在可用区ID - readOnly: true - storage_type: - type: string - example: inmemory - description: 实例存储类型 - readOnly: true - max_connections: - type: integer - example: 1000000 - description: 实例最大连接数 - readOnly: true - -ElasticCacheSkuListResponse: - type: object - properties: - limit: - type: integer - example: 20 - elasticcacheskus: - type: array - items: - $ref: "#/ElasticCacheSku" - total: - type: integer - example: 124 - -ElasticCacheSkuResponse: - type: object - properties: - elasticcachesku: - type: object - $ref: "#/ElasticCacheSku" - -ElasticCacheCreate: - type: object - properties: - name: - type: string - example: test-instance - description: 实例名称 - cloudregion: - type: string - example: ebb5abd3-8ffb-42ec-8bc6-38ba5b949885 - description: 实例所在区域 Id - zone: - type: string - example: 70802da8-affe-4247-8ce8-610f205019ca - description: 实例所在可用区 Id - network: - type: string - example: 70802da8-affe-4247-8ce8-610f205019ca - description: 实例所在子网 Id - engine: - type: string - example: redis - description: 实例引擎 redis - engine_version: - type: string - example: "4.0" - enum: ["2.8", "3.0", "4.0", "5.0"] - password: - type: string - example: dfdf11AAZ - description: 实例访问密码 - instance_type: - type: string - example: 80802da8-affe-4247-8ce8-610f205019ca - description: 实例规格ID - billing_type: - type: string - example: postpaid - description: 计费类型， postpaid|prepaid - billing_cycle: - type: string - example: 1M - description: 计费周期， eg. 1M 1Y - -ElasticCacheAccountCreate: - type: object - properties: - name: - type: string - example: test-instance - description: 账号名称 - password: - type: string - example: dfdf11AAZ - description: 账号访问密码 - account_privilege: - type: string - example: read - description: 账号权限 read|write|repl - elasticache: - type: string - example: 90802da8-affe-4247-8ce8-610f205019ca - description: 实例ID - -ElasticCacheAclCreate: - type: object - properties: - name: - type: string - example: test-instance - description: 访问控制名称 - ip_list: - type: string - example: 192.168.0.1,192.168.0.2 - description: 访问控制IP列表，逗号分隔 - elasticache: - type: string - example: 90802da8-affe-4247-8ce8-610f205019ca - description: 实例ID - -ElasticCacheAclUpdate: - type: object - properties: - ip_list: - type: string - example: 192.168.0.1,192.168.0.2 - description: 访问控制IP列表，逗号分隔 - -ElasticCacheParameterUpdate: - type: object - properties: - id: - type: string - example: 10802da8-affe-4247-8ce8-610f205019ca - description: 参数ID - value: - type: string - example: 1000 - description: 参数值 - -ElasticCacheAllocatePublicConnection: - type: object - properties: - port: - type: integer - required: false - example: 6379 - description: 公网访问端口号， 1024~65535 - -ElasticCacheChangeSpec: - type: object - properties: - sku: - type: string - required: true - example: 10802da8-affe-4247-8ce8-610f205019ca - description: 规格ID - -ElasticCacheSetMaintainTime: - type: object - properties: - maintain_start_time: - type: string - required: true - example: "00:00" - description: 维护开始时间, 格式:'HH:mm' - maintain_end_time: - type: string - required: true - example: "02:00" - description: 维护结束时间, 格式:'HH:mm' - -ElasticCacheAuthMode: - type: object - properties: - auth_mode: - type: string - required: true - example: on - description: 认证模式, on（开启密码认证）|off(关闭密码认证) - -ElasticCacheBackupPolicy: - type: object - properties: - backup_type: - type: string - required: false - example: automated - description: 备份类型, automated | manual - backup_reserved_days: - type: integer - required: false - example: 7 - description: 备份保留天数, 1~7 - preferred_backup_period: - type: string - required: true - example: Monday - description: 备份周期, Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday - preferred_backup_time: - type: string - required: true - example: 00:00Z-02:00Z - description: 备份时间段, 格式： 'HH:mmZ-HH:mmZ' - -ElasticCacheResetPassword: - type: object - properties: - password: - type: string - required: false - example: pxxxword - description: 新密码 - reset_password: - type: boolean - required: false - example: true - description: 新密码 - -ElasticCacheLoginInfoResponse: - type: object - properties: - password: - type: string - example: 1111111 - username: - type: string - example: testUser diff --git a/docs/schemas/elasticip.yaml b/docs/schemas/elasticip.yaml deleted file mode 100644 index 39eaf0e1cc..0000000000 --- a/docs/schemas/elasticip.yaml +++ /dev/null @@ -1,126 +0,0 @@ -ElasticIpCreate: - type: object - properties: - name: - type: string - example: test-elasticip - required: true - description: 弹性IP名称 - description: - type: string - example: elasticip-description - description: 弹性IP描述 - region: - type: string - example: be2581d5-4c35-4e5d-8235-8861061b660d - required: true - description: 区域名称或ID - manager: - type: string - example: b3b6fcc4-3fa5-450a-89b5-26d855e6f102 - required: true - description: 子订阅名称或ID - charge_type: - type: string - example: bandwidth - default: triffic - description: 计费类型，traffic or bandwidth - network: - type: string - example: be2581d5-4c35-4e5d-8235-8861061b660d - description: 子网名称或ID，私有云必须指定子网 - bandwidth: - type: integer - default: 0 - description: 带宽大小 - auto_dellocate: - type: boolean - default: false - description: 是否解绑时自动删除 - ip_addr: - type: string - description: 仅私有云可以指定ip子网内的IP - -ElasticIpResponse: - type: object - properties: - elasticip: - type: object - $ref: '#/ElasticIp' - -ElasticIp: - allOf: - - $ref: "./common.yaml#/VirtualResourceBaseResponse" - - $ref: "./common.yaml#/BillingBaseResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - properties: - associate_id: - type: string - example: 0b50463b-929f-44a1-86e0-274f73f9de05 - description: 弹性IP绑定的设备ID - associate_type: - type: string - example: server - enum: [loadbalancer, server, natgateway] - description: 弹性IP绑定的设备类型 - bandwidth: - type: integer - example: 0 - description: 弹性IP带宽大小,单位(Mbps) - network_id: - type: string - example: be2581d5-4c35-4e5d-8235-8861061b660d - description: IP子网ID，目前仅私有云会有这个字段 - mode: - type: string - example: elastic_ip - enum: [elastic_ip, public_ip] - description: 弹性IP或固定公网IP - ip_addr: - type: stirng - example: 47.93.237.215 - description: 弹性IP地址 - charge_type: - type: string - example: traffic - enum: [traffic, bandwidth] - description: 按带宽还是按流量计费 - # bgp_type: - # type: string - # example: - # description: 目前华为云需要此字段 - auto_dellocate: - type: boolean - example: false - description: 解绑EIP时是否自动删除EIP - cloudregion_id: - type: string - example: 60c86e4a-5a44-48c3-8ddb-57799a2207e2 - description: 所在区域ID - -ElasticIpListResponse: - type: object - properties: - limit: - type: integer - example: 20 - elasticips: - type: array - items: - $ref: '#/ElasticIp' - total: - type: integer - example: 124 - -ElasticIpUpdate: - type: object - properties: - name: - type: string - example: test-keypair - description: 弹性IP名称 - description: - type: string - example: keypair-description - description: 弹性IP描述 diff --git a/docs/schemas/endpoint.yaml b/docs/schemas/endpoint.yaml deleted file mode 100644 index 16daaed46b..0000000000 --- a/docs/schemas/endpoint.yaml +++ /dev/null @@ -1,111 +0,0 @@ -EndpointListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - endpoints: - type: array - items: - $ref: "#/Endpoint" - -EndpointGetResponse: - type: object - properties: - endpoint: - type: object - $ref: "#/Endpoint" - -EndpointPutRequestInput: - type: object - properties: - name: - type: string - description: 接入点的名称 - url: - type: string - description: 接入点的URL - description: - type: string - description: 接入点的描述 - enabled: - type: boolean - description: 是否启用／禁用接入点 - -EndpointCreateInput: - type: object - properties: - name: - type: string - description: 接入点的名称，全局唯一 - example: keystone - url: - type: string - description: 接入点的URL - required: true - enabled: - type: boolean - description: 接入点是否启用／禁用 - default: true - description: - type: string - description: 接入点的描述 - service_id: - type: string - description: 接入点所属的服务ID - required: true - region_id: - type: string - description: 接入点所属的区域ID - required: true - example: Beijing - interface: - type: string - description: 接入点的接口类型，可能值为：internal, public, admin, console - example: internal, public, admin, console - required: true - -Endpoint: - type: object - description: 接入点 - properties: - id: - type: string - description: 接入点ID - readOnly: true - name: - type: string - description: 接入点名称，全局唯一 - service_type: - type: string - description: 接入点所属服务的类型 - service_name: - type: string - description: 接入点所属服务的名称 - service_id: - type: string - description: 接入点所属服务的ID - region_id: - type: string - description: 接入点所在区域的ID - interface: - type: string - description: 接入点的接口类型 - url: - type: string - description: 接入点的URL - enabled: - type: boolean - description: 接入点是否启用／禁用 - can_delete: - type: boolean - description: 是否可以删除 - description: - type: string - description: 接入点的描述信息 diff --git a/docs/schemas/group.yaml b/docs/schemas/group.yaml deleted file mode 100644 index 6e20327d1d..0000000000 --- a/docs/schemas/group.yaml +++ /dev/null @@ -1,71 +0,0 @@ -GroupListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - groups: - type: array - items: - $ref: "#/Group" - -GroupGetResponse: - type: object - properties: - group: - type: object - $ref: "#/Group" - -GroupPutRequestInput: - type: object - properties: - name: - type: string - description: 组的名称 - description: - type: string - description: 组的描述 - -GroupCreateInput: - type: object - properties: - name: - type: string - required: true - description: 组的名称 - description: - type: string - description: 组的描述 - -Group: - type: object - description: 组 - properties: - id: - type: string - description: 组ID - readOnly: true - name: - type: string - description: 组名，域内唯一 - can_delete: - type: boolean - description: 是否可以删除 - idp_id: - type: string - description: 如果该组为从认证源导入，则idp_id为该认证源的ID - idp: - type: string - description: 如果该组为从认证源导入，则idp为该认证源的name - idp_driver: - type: string - description: 如果该组为从认证源导入，则idp_driver为该认证源的driver - idp_entity_id: - type: string - description: 如果该组为从认证源导入，则idp_entity_id为该域对应资源的原始ID diff --git a/docs/schemas/guest_image.yaml b/docs/schemas/guest_image.yaml deleted file mode 100644 index 3d72b61ca8..0000000000 --- a/docs/schemas/guest_image.yaml +++ /dev/null @@ -1,107 +0,0 @@ -GuestImageListResponse: - type: object - properties: - limit: - type: interger - example: 20 - guestimages: - type: array - items: - $ref: '#/GuestImage' - total: - type: integer - example: 124 - -GuestImageResponse: - type: object - properties: - guestimage: - type: object - $ref: '#/GuestImage' - -GuestImage: - type: object - description: 主机镜像 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 镜像ID - readOnly: true - can_delete: - type: boolean - example: true - description: 镜像是否可以删除 - can_update: - type: boolean - example: true - description: 镜像是否可以更新 - created_at: - type: string - example: 2019-05-30T09:23:16.000000Z - description: 镜像创建时间 - name: - type: string - example: ubuntu-16.04.5-server-20181117.qcow2 - description: 镜像名称 - properties: - type: object - $ref: './image.yaml#/ImageProperties' - protected: - type: boolean - example: true - description: 是否受保护 - size: - type: integer - example: 792592384 - description: 主机镜像实际大小(系统盘镜像和数据盘镜像的大小之和),单位Byte - min_ram_size: - type: integer - example: 2048 - description: 创建vm时的最低内存限制 - root_image: - type: object - $ref: '#/SubImageInfo' - description: 系统盘镜像 - data_images: - type: array - items: - $ref: '#/SubImageInfo' - description: 数据盘镜像列表 - status: - type: string - example: active - enum: [queued,saving,active,converting] - description: 镜像状态, queued(队列中), saving(保存中), active(可用) - tenant: - type: string - example: system - description: 所属项目名称 - tenant_id: - type: string - example: a7f2e2a81a1e4850a41eae5f140ceb14 - description: 所属项目ID - updated_at: - type: string - example: 2019-05-30T09:26:41.000000Z - description: 最近一次更新时间 - -SubImageInfo: - type: object - description: 子镜像信息 - properties: - id: - type: string - example: fasd2344-5470-32f3-4d47-f53323f40361 - description: 子镜像的ID - name: - type: string - example: root - description: 子镜像的Name - min_disk_mb: - type: integer - example: 40960 - description: 磁盘最低大小限制(MB) - disk_format: - type: string - description: 磁盘格式 diff --git a/docs/schemas/host.yaml b/docs/schemas/host.yaml deleted file mode 100644 index 28cdaa301a..0000000000 --- a/docs/schemas/host.yaml +++ /dev/null @@ -1,486 +0,0 @@ -Host: - type: object - description: 宿主机 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 宿主机uuid - readOnly: true - name: - type: string - description: 宿主机名称 - example: host-r4hilqks - readOnly: true - billing_type: - type: string - description: 计费类型 - example: postpaid - readOnly: true - zone: - type: string - example: 腾讯云 广州三区 - description: 可用区名称 - zone_id: - type: string - example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0efc - description: 可用区ID - region: - type: string - example: 腾讯云 华南地区(广州) - description: 区域名称 - region_id: - type: string - example: 13947bd8-569e-4094-8b03-4339c2a8e45b - description: 区域ID - update_version: - type: integer - example: 2 - description: 资源被更新的次数 - updated_at: - type: string - example: 2019-05-30T06:36:39.000000Z - description: 资源最近一次更新时间 - provider: - type: string - example: Qcloud - description: 纳管云平台 - brand: - type: string - example: DStack - description: 虚拟化品牌 - created_at: - type: string - example: 2019-05-30T02:25:38.000000Z - description: 资源创建时间 - access_ip: - type: string - example: 10.168.222.234 - description: 宿主机Master网卡ip - access_mac: - type: string - example: 00:22:d5:9e:28:d2 - description: 宿主机master网卡mac - can_delete: - type: boolean - example: false - description: 宿主机是否能删除 - can_update: - type: boolean - example: true - description: 宿主机是否能更新 - cloud_env: - type: string - example: onpremise - description: 宿主机所属的云类型 - cpu_cache: - type: integer - example: 16384 - description: 宿主机cpu缓存大小 - cpu_cmtbound: - type: float - example: 4.000000 - description: 宿主机cpu超售比 - cpu_commit: - type: integer - example: 1 - description: 宿主机已分配cpu个数 - cpu_commit_rate: - type: float - example: 0.125000 - description: 宿主机已分配cpu比率 - cpu_count: - type: integer - example: 8 - description: 宿主机cpu个数 - cpu_desc: - type: string - example: Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz - description: 宿主机cpu型号信息 - cpu_mhz: - type: integer - example: 2793 - description: 宿主机cpu频率，近似值 - cpu_microcode: - type: string - example: 0x1 - description: 宿主机cpu微码 - cpu_reserved: - type: integer - example: 0 - description: 宿主机预留cpu个数 - description: - type: string - example: test host - description: 宿主机备注信息 - enabled: - type: boolean - example: false - description: 宿主机是否启用 - guests: - type: integer - example: 3 - description: 宿主机上虚拟机个数 - host_status: - type: string - example: offline - description: 宿主机状态 - host_type: - type: string - example: hypervisor - description: 宿主机类型 - is_baremetal: - type: boolean - example: false - description: 是否是物理机 - is_emulated: - type: boolean - example: false - description: 是否是虚拟资源 - is_import: - type: boolean - example: false - description: 是否是托管的宿主机 - is_maintenance: - type: boolean - example: false - description: 物理机是否在维护状态 - is_prepaid_recycle: - type: boolean - example: false - description: 宿主机在预付费资源池中 - manager_uri: - type: string - example: http://10.168.222.234:8885 - description: 宿主机服务地址 - mem_cmtbound: - type: float - example: 1.000000 - description: 宿主机内存超售比 - mem_commit: - type: integer - example: 10240 - description: 已分配内存/MB - mem_commit_rate: - type: float - example: 0.125000 - description: 已分配内存比率 - mem_reserved: - type: integer - example: 1024 - description: 预留内存数量 - meme_size: - type: integer - example: 8192 - description: 宿主机内存大小 - nic_count: - type: integer - example: 1 - description: 宿主机上网卡数量 - nic_info: - type: string - description: 网卡信息 - node_count: - type: integer - example: 1 - description: 宿主机上cpu node数量 - nonsystem_guests: - type: integer - example: 4 - description: 非系统资源的虚拟机数量 - rack: - type: string - example: rack0 - description: 机架信息 - resource_type: - type: string - example: shared - enum: [shared,prepaid,dedicated] - description: 资源类型 - slots: - type: string - example: slot0 - description: 内存插槽 - sn: - type: string - example: 6CR338WPFP - description: 机器序列号 - status: - type: string - example: running - description: 物理机状态 - storage: - type: integer - example: 201456 - description: 宿主机存储大小 - spec: - type: string - example: {"cpu":8,"mem":8192,"nic_count":0} - description: 宿主机简略信息 - storage_commit_rate: - type: float - example: 0.760000 - description: 宿主机存储分配比率 - storage_driver: - type: string - example: Linux - description: 宿主机存储驱动 - storage_free: - type: integer - example: 47856 - description: 宿主机存储剩余大小 - storage_size: - type: integer - example: 201456 - description: 宿主机存储大小 - storage_type: - type: string - example: rotate - description: 宿主机存储类型，机械盘/ssd - storage_used: - type: integer - example: 153600 - description: 宿主机已使用存储大小 - storage_virtual: - type: integer - example: 201456 - description: 宿主机存储大小(虚拟大小，宿主机存储可超售) - storage_waste: - type: integer - example: 201456 - description: 宿主机浪费存储大小 - sys_info: - type: string - description: 宿主机上一些元信息 - -HostResponse: - type: object - properties: - host: - type: object - $ref: '#/Host' - -HostListResponse: - type: object - properties: - limit: - type: integer - example: 20 - hosts: - type: array - items: - $ref: '#/Host' - total: - type: integer - example: 124 - -HostUpdate: - type: object - properties: - name: - type: string - example: new-host-name - desc: - type: string - example: new-host-desc - cpu_commit_bound: - type: float - example: 4.0 - description: 宿主机cpu超售比 - memory_commit_bound: - type: float - example: 1.1 - description: 宿主机内存超售比 - memory_reserved: - type: integer - example: 10240 - description: 宿主机预留内存大小 - cpu_reserved: - type: integer - example: 10 - description: 宿主机预留cpu大小 - host_type: - type: string - enum: [hypervisor,kubelet,esxi,baremetal] - description: 宿主机类型 - access_ip: - type: string - description: 宿主机access ip - -HostCreate: - type: object - properties: - name: - type: string - example: new-host-name - required: true - mac: - type: string - description: 物理机的mac地址 - required: true - rack: - type: string - description: rack number of baremtal - slots: - type: string - description: slots number of baremetal - ipmi_user: - type: string - description: ipmi 用户名 - ipmi_passwd: - type: string - description: ipmi密码 - ipmi_addr: - type: string - description: ipmi地址 - -HostIpmi: - type: object - properties: - ip_addr: - type: string - description: ipmi地址 - lan_channel: - type: integer - description: ipmi信道 - password: - type: string - description: ipmi登录密码 - username: - type: string - description: ipmi用户名 - -HostConvertHypervisor: - type: object - properties: - name: - type: string - required: true - description: 转换的宿主机的名字 - host_type: - type: string - required: true - enum: [hypervisor,esxi,kubelet,hyperv] - description: 转换后的宿主机类型 - image: - type: string - description: 转换成宿主机所用的镜像 - raid: - type: string - enum: [raid0,raid1,raid10,raid5,none] - description: 物理机磁盘raid类型 - baremetal_disk_config: - type: array - description: 物理机磁盘raid配置 - $ref: '#/BaremetalDiskConfig' - disk: - type: array - description: 宿主机磁盘配置信息 - $ref: "../schemas/instance.yaml#/InstanceDiskInfo" - net: - type: array - description: 宿主机网卡配置信息 - $ref: "#/Network" - -Network: - type: object - properties: - index: - type: integer - example: 0 - description: 网络索引编号 - network: - type: string - example: dab5b874-755a-4223-89a5-4acf36305756 - description: 网络名称或ID - wire: - type: string - example: a53adc31-7601-4ddf-8874-93639f5626db - description: 二层网络名称或ID - exit: - type: boolean - default: false - example: true - description: 是否是外网ip - address: - type: string - example: 192.168.222.203 - description: 分配的IP地址 - -BaremetalDiskConfig: - type: object - properties: - type: - type: string - enum: [ssd, rotate] - description: 磁盘介质类型 - conf: - type: string - enum: [raid0,raid1,raid10,raid5,none] - description: raid 配置信息 - count: - type: integer - description: 使用几块盘做raid(连续的) - range: - type: array - items: - $ref: '#/RaidRange' - description: 使用指定的磁盘做raid - adapter: - type: integer - example: 2 - description: raid卡上的adapter - driver: - type: string - example: MegaRaid - description: raid卡类型 - -RaidRange: - type: integer - description: 磁盘号 - -HostAddNetif: - type: object - properties: - wire: - type: string - required: true - description: 物理机所属的wire Id或Name - mac: - type: string - required: true - description: 添加的网卡的mac地址 - type: - type: string - enum: [admin, ipmi] - description: 网卡类型 - ip_address: - type: string - description: 网卡的ip地址 - -HostRemoveNetif: - type: object - properties: - mac: - type: string - required: true - description: 要移除网卡的mac地址 - -HostSpec: - type: object - properties: - cpu: - type: integer - description: 宿主机cpu数量 - disk: - type: string - description: 宿主机磁盘配置信息 - driver: - type: string - description: 宿主机存储驱动 - nic_count: - type: integer - description: 宿主机上网卡数量 - manufacture: - type: string - description: 宿主机厂商信息 diff --git a/docs/schemas/hoststorage.yaml b/docs/schemas/hoststorage.yaml deleted file mode 100644 index 8186606d7f..0000000000 --- a/docs/schemas/hoststorage.yaml +++ /dev/null @@ -1,78 +0,0 @@ -HostStorage: - type: object - description: 宿主机与存储关联表 - properties: - host_id: - type: string - description: 宿主机ID - host: - type: string - description: 宿主机名称 - baremetal: - type: string - description: 宿主机对应的物理机名称 - storage_id: - type: string - description: 存储ID - mount_point: - type: string - example: /data - description: 挂载点 - storagecache_id: - type: string - description: 缓存ID - imagecache_path: - type: string - example: /opt/cloud/workspace/disks/imagecache - description: 镜像缓存路径 - can_delete: - type: boolean - description: 是否可删除 - can_update: - type: boolean - description: 是否可以更新资源属性 - created_at: - type: string - example: 2019-05-30T02:25:38.000000Z - description: 资源创建时间 - capacity: - type: integer - example: 10240 - description: 存储容量(单位MB) - storage_type: - type: string - example: local - description: 存储集群类型 - free_capacity: - type: integer - example: 10240 - description: 剩余存储容量(单位MB) - cmtbound: - type: float - example: 1.000000 - description: 超售比 - guest_disk_count: - type: integer - example: 10 - description: 磁盘数量 - -HostStorageListResponse: - type: object - properties: - limit: - type: integer - example: 20 - storages: - type: array - items: - $ref: '#/HostStorage' - total: - type: integer - example: 124 - -HostStorageResponse: - type: object - properties: - storage: - type: object - $ref: '#/HostStorage' \ No newline at end of file diff --git a/docs/schemas/identity_provider.yaml b/docs/schemas/identity_provider.yaml deleted file mode 100644 index 41cb000f1f..0000000000 --- a/docs/schemas/identity_provider.yaml +++ /dev/null @@ -1,69 +0,0 @@ -IdpListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - identity_providers: - type: array - items: - $ref: "#/Idp" - -IdpGetResponse: - type: object - properties: - identity_provider: - type: object - $ref: "#/Idp" - -IdpPutRequestInput: - type: object - properties: - name: - type: string - description: 认证源的名称 - description: - type: string - description: 认证源的描述 - -IdpCreateInput: - type: object - properties: - name: - type: string - required: true - description: 认证源的名称 - driver: - type: string - required: true - description: 认证源的driver - description: - type: string - description: 认证源的描述 - -Idp: - type: object - description: 认证源 - properties: - id: - type: string - description: 认证源ID - readOnly: true - name: - type: string - description: 认证源名称 - can_delete: - type: boolean - description: 是否可以删除 - driver: - type: string - description: 认证源类型，目前支持sql, ldap两种 - template: - type: string - description: 认证源配置模板，跟driver相关。当driver为ldap时，支持三种模板：msad_one_domain,openldap_one_domain,msad_multi_domain diff --git a/docs/schemas/image.yaml b/docs/schemas/image.yaml deleted file mode 100644 index 8e811d0a09..0000000000 --- a/docs/schemas/image.yaml +++ /dev/null @@ -1,132 +0,0 @@ -ImageListResponse: - type: object - properties: - limit: - type: integer - example: 20 - images: - type: array - items: - $ref: '#/Image' - total: - type: integer - example: 124 - -ImageResponse: - type: object - properties: - image: - type: object - $ref: '#/Image' - -ImageMarkStandard: - type: object - properties: - is_standard: - type: bool - example: true - description: 设置镜像是否为标准镜像 - -Image: - type: object - description: 镜像 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 镜像ID - readOnly: true - can_delete: - type: boolean - example: true - description: 镜像是否可以删除 - can_update: - type: boolean - example: true - description: 镜像是否可以更新 - checksum: - type: string - example: ef7a1c502ee2c9a288486f91d24330f0 - description: 镜像MD5值 - created_at: - type: string - example: 2019-05-30T09:23:16.000000Z - description: 镜像创建时间 - disk_format: - type: string - example: qcow2 - description: 镜像上传时的格式 - is_public: - type: boolean - example: true - description: 是否是标准镜像 - min_disk: - type: integer - example: 30720 - description: 镜像要求的最低磁盘大小,单位Mb - min_ram: - type: integer - example: 0 - description: 镜像要求的最低内存大小 - name: - type: string - example: ubuntu-16.04.5-server-20181117.qcow2 - description: 镜像名称 - properties: - type: object - $ref: '#/ImageProperties' - protected: - type: boolean - example: true - description: 是否受保护 - size: - type: integer - example: 792592384 - description: 镜像实际大小,单位Byte - status: - type: string - example: active - enum: [queued,saving,active,converting] - description: 镜像状态, queued(队列中), saving(保存中), active(可用), converting(格式转换中) - tenant: - type: string - example: system - description: 所属项目名称 - tenant_id: - type: string - example: a7f2e2a81a1e4850a41eae5f140ceb14 - description: 所属项目ID - updated_at: - type: string - example: 2019-05-30T09:26:41.000000Z - description: 最近一次更新时间 - is_guest_image: - type: boolean - example: true - description: 是否是主机镜像的一部分 - is_data: - type: boolean - example: true - description: 是否是数据盘的镜像 - - -ImageProperties: - type: object - description: 镜像属性 - properties: - os_arch: - type: string - example: x86 - description: 操作系统架构 - os_distribution: - type: string - example: Ubuntu - description: 操作系统发行版 - os_type: - type: string - example: Linux - description: 操作系统类型 - os_version: - type: string - example: 16.0 - description: 操作系统版本 diff --git a/docs/schemas/instance.yaml b/docs/schemas/instance.yaml deleted file mode 100644 index c0cdca3c72..0000000000 --- a/docs/schemas/instance.yaml +++ /dev/null @@ -1,1142 +0,0 @@ -InstanceMonitor: - type: object - required: - - command - properties: - command: - type: string - example: block info - description: qemu-monitor command - -InstanceSaveImage: - type: object - required: - - name - properties: - name: - type: string - example: test-save-image - description: 保存镜像的名称 - auto_start: - type: boolean - default: false - example: true - description: 保存镜像后自动启动 - notes: - type: string - example: save-image-info - description: 镜像描述信息 - -InstanceMigrate: - type: object - properties: - rescue_mode: - type: boolean - example: true - description: 是否进入救援模式 - prefer_host: - type: string - example: a53adc31-7601-4ddf-8874-93639f5626db - description: 指定迁移的宿主机名称或ID - auto_start: - type: boolean - example: true - description: 迁移后是否自动启动 - - -InstanceLiveMigrate: - type: object - properties: - prefer_host: - type: string - example: a53adc31-7601-4ddf-8874-93639f5626db - description: 指定迁移的宿主机名称或ID - - -InstanceDeploy: - type: object - properties: - keypair: - type: string - example: 3bce9607-2597-469f-8d9b-977345456739 - description: 待绑定的秘钥名称或ID - __delete_keypair__: - type: boolean - example: true - description: 解绑秘钥 - password: - type: string - example: jK9nPU&dSE9k8A^z - description: 重设密码 - reset_password: - type: boolean - example: true - description: 若不指定password,会随机生成密码 - restart: - type: boolean - example: true - default: false - description: 重置密码后是否重启, 此参数对于在线重置密码的实例无效 - - -InstanceAttachDisk: - type: object - required: - - disk_id - properties: - disk_id: - type: string - example: 3bce9607-2597-469f-8d9b-977345456739 - description: 待挂载的磁盘名称或ID - - -InstanceInsertIso: - type: object - required: - - image_id - properties: - image_id: - type: string - example: 3bce9607-2597-469f-8d9b-977345456739 - description: 光盘ID - -InstanceAddSecgroup: - type: object - required: - - secgrp.0 - properties: - secgrp.0: - type: string - example: 3bce9607-2597-469f-8d9b-977345456739 - description: 待绑定的安全组名称或ID - secgrp.1: - type: string - example: 38dc8e80-14e5-4629-81c1-3847320ae821 - description: 待绑定的安全组名称或ID - -InstanceIoThrottle: - type: object - properties: - iops: - type: integer - example: 1000 - description: 最高iops - bps: - type: integer - example: 1000 - description: 最高bps，单位MB - -InstanceRevokeSecgroup: - type: object - required: - - secgrp.0 - properties: - secgrp.0: - type: string - example: 3bce9607-2597-469f-8d9b-977345456739 - description: 待绑定的安全组名称或ID - secgrp.1: - type: string - example: 38dc8e80-14e5-4629-81c1-3847320ae821 - description: 待绑定的安全组名称或ID - - -InstanceAssignSecgroup: - type: object - required: - - secgrp - properties: - secgrp: - type: string - example: 3bce9607-2597-469f-8d9b-977345456739 - description: 待替换的安全组名称或ID - - -InstanceSetSecgroup: - type: object - required: - - secgrp.0 - properties: - secgrp.0: - type: string - example: 3bce9607-2597-469f-8d9b-977345456739 - description: 待绑定的安全组名称或ID - secgrp.1: - type: string - example: 38dc8e80-14e5-4629-81c1-3847320ae821 - description: 待绑定的安全组名称或ID - -InstanceCreateDisk: - type: object - required: - - disks - properties: - disks: - type: array - items: - $ref: '#/InstanceDisk' - description: 待创建的磁盘列表 - - -InstanceDetachDisk: - type: object - required: - - disk_id - properties: - disk_id: - type: string - example: 38dc8e80-14e5-4629-81c1-3847320ae821 - description: 待卸载的磁盘名称或ID - keep_disk: - type: boolean - default: false - example: true - description: 卸载后的磁盘是否立即删除 - - -InstanceDetachIsolateDevice: - type: object - required: - - device - properties: - device: - type: string - example: 38dc8e80-14e5-4629-81c1-3847320ae821 - description: 待卸载透传设备的名称或ID - -InstanceAttachIsolateDevice: - type: object - required: - - device - properties: - device: - type: string - example: 38dc8e80-14e5-4629-81c1-3847320ae821 - description: 待挂载透传设备的名称或ID - -InstanceChangeIpAddr: - type: object - required: - - net_desc - properties: - reserve: - type: boolean - default: false - example: true - description: 是否是保留IP - ip_addr: - type: string - example: 192.168.222.203 - description: 待更换的ip地址 - mac: - type: string - example: 98:90:96:a9:4a:10 - description: 待更换网卡的MAC地址 - index: - type: integer - example: 1 - description: 待更换网卡的索引 - net_desc: - type: object - $ref: '#/InstanceNetwork' - - -InstanceNetwork: - type: object - properties: - idx: - type: integer - example: 0 - description: 网络索引 - network: - type: string - example: dab5b874-755a-4223-89a5-4acf36305756 - description: 网络名称或ID - wire: - type: string - example: a53adc31-7601-4ddf-8874-93639f5626db - description: 二层网络名称或ID - exit: - type: boolean - default: false - example: true - description: 是否是外网ip - address: - type: string - example: 192.168.222.203 - description: 分配的IP地址 - - -InstanceDetachNetwork: - type: object - required: - - net_id - properties: - reserve: - type: boolean - default: false - example: true - description: 是否是保留IP - net_id: - type: string - example: a53adc31-7601-4ddf-8874-93639f5626db - description: 网络ID - ip_addr: - type: string - example: 192.168.222.203 - description: 解绑的网卡IP地址 - mac: - type: string - example: 40:a8:f0:c9:64:91 - description: 解绑的网卡MAC地址 - - -InstanceAttachNetwork: - type: object - required: - - net_desc - properties: - net_desc: - type: object - $ref: '#/InstanceNetwork' - - -InstanceChangeBandwidth: - type: object - required: - - bandwidth - properties: - bandwidth: - type: integer - example: 40 - description: 更改后的带宽值 - ip_addr: - type: string - example: 192.168.222.203 - description: 待更换的ip地址 - mac: - type: string - example: 98:90:96:a9:4a:10 - description: 待更换网卡的MAC地址 - index: - type: integer - example: 1 - description: 待更改带宽的网卡索引 - - -InstanceChangeConfig: - type: object - properties: - instance_type: - type: string - example: ecs.c1.c1m1 - description: 更换实例规格 - vcpu_count: - type: integer - example: 6 - description: 更改CPU大小 - vmem_size: - type: string - example: 8G - description: 更改内存大小 - disks: - type: array - items: - $ref: '#/InstanceDiskInfo' - auth_start: - type: boolean - default: false - example: true - description: 更改配置后自动启动 - -InstanceReset: - type: object - properties: - is_hard: - type: boolean - default: false - example: true - description: 是否硬重启 - -InstanceStatus: - type: object - properties: - status: - type: string - example: ready - description: 设置实例的状态 - -InstanceStop: - type: object - properties: - is_force: - type: boolean - default: false - example: true - description: 是否强制关闭实例 - -InstanceRestart: - type: object - properties: - is_force: - type: boolean - default: false - example: true - description: 是否强制关闭实例 - - -InstanceSendKeys: - type: object - required: [keys] - properties: - keys: - type: string - example: delete - description: 按键 - -InstanceAssociateEip: - type: object - required: [eip] - properties: - eip: - type: string - example: f0a7e768-8011-4d74-8844-a239eb061214 - description: 弹性IP名称或ID - -InstanceDissociateEip: - type: object - properties: - auto_delete: - type: boolean - default: false - example: true - description: 解绑的弹性IP是否立即删除 - -InstanceCreateEip: - type: object - properties: - charge_type: - type: string - default: traffic - example: bandwidth - enum: [traffic,bandwidth] - description: 弹性IP计费模式 - bandwidth: - type: integer - example: 10 - description: 弹性IP带宽 - - -InstanceUserData: - type: object - required: [user_data] - properties: - user_data: - type: string - example: I2Nsb3VkLWNvbmZpZwpkaXNhYmxlX3Jvb3Q6IDAKcGhvbmVfaG9tZToKICB1cmw6IGh0dHA6Ly93d3cueXVuaW9uLmlvLyRJTlNUQU5DRV9JRApydW5jbWQ6CiAgLSBta2RpciAvdmFyL3J1bi9odHRwZApzc2hfcHdhdXRoOiAxCnVzZXJzOgogIC0gZGVmYXVsdAogIC0gbmFtZTogcm9vdAogICAgc3NoX2F1dGhvcml6ZWRfa2V5czoKICAgICAgLSBzc2gtcnNhIEFBQUFCM056YUMxeWMyRUFBQUFEQVFBQkFBQUJBUUNhNEU4d21JT2xtaDFHOFpSY1UyenBubDJmckQybExLZFhwYlRlVVVaRUtZRkZsWU04VE01VXJLcnFyTUNkM3JGamFZR1RLV2lRd09pV3JvWGxBWGF1c2JiVkVJMjlLWSsxVmQyNnFOeWVqaitDWk85TUNqMG5hSXJxYTFWMG9mM1RRWTVJMlUrVG9Ja3lMcVZGV2hXVmE1N3YvR1V4c1YyYU5UbVVTL3F6ME9QU0NGUGJHV1dCMzVyc2p3bkZ3cTJqRjZFOHlKZ1RHRFRZWmNzZ2hSaTNJV2Z5ZmVIYlN1V2R2bjZOOFhyUEJEbU5nN2grR1N2TzZGSmxwNk1VdzFoc2NFQ2kxM0d3cVhZZ0puTEc1Uk1pRkg2czB2aG96eUhrdWUxdk9UY3J5UEhSUUQwSnovSU5VU2FnZ0g4TDFIbllTVWF2T2Y0Q3cyNVc5SGZ6Z1VCZgogIC0gbG9ja19wYXNzd2Q6IGZhbHNlCiAgICBuYW1lOiB5dW5pb24KICAgIHBhc3N3ZDogJDYkTWh5ZEE4OXYkdGdqQVNyTVVTUC9UZmJaWVdCVnRZSUhJcy5yRkVtejYvdDZjOWJUMTk5aTkzWUpuNUtxcy9DNkVZSXBIRk9tZFZUZ0F5SGozSUlnVk5MWVN5VS5VVi4KICAgIHN1ZG86IEFMTD0oQUxMKSBOT1BBU1NXRDpBTEwKd3JpdGVfZmlsZXM6CiAgLSBjb250ZW50OiBaMjlpZFdsc1pBcGpiRzkxWkdWMkNnPT0KICAgIGVuY29kaW5nOiBiNjQKICAgIHBhdGg6IC9ldGMvYW5zaWJsZS9ob3N0cwogIC0gY29udGVudDogfAogICAgICAxMjcuMC4wLjEgbG9jYWxob3N0CiAgICAgIAogICAgcGF0aDogL2V0Yy9ob3N0cw== - description: user-data数据 - -InstanceDeleteBackup: - type: object - properties: - purge: - type: boolean - default: false - example: true - description: 是否清除数据 - -InstanceSetExtraOption: - type: object - required: [key] - properties: - key: - type: string - description: key - value: - type: string - description: value - - -InstanceDelExtraOption: - type: object - required: [key] - properties: - key: - type: string - description: key - - -InstanceRenew: - type: object - required: [duration] - properties: - duration: - type: string - example: 1M - description: 续费时长 - - -InstanceRebuildRoot: - type: object - properties: - image_id: - type: string - example: f0a7e768-8011-4d74-8844-a239eb061214 - description: 镜像ID,若不传此参数，会默认使用原系统镜像 - auto_start: - type: boolean - default: false - example: true - description: 重装系统后自动启动 - reset_password: - type: boolean - default: true - example: false - description: 重置密码 - password: - type: string - example: xoYG0Q08JgGqTQP8 - description: 手动指定密码，若reset_password=true, password为空,会默认随机生成密码 - keypair: - type: string - example: fc7544d0-d12b-439e-8d91-f77f3d54c06b - description: 密码名称或密码 - all_disks: - type: boolean - default: false - example: true - description: 重置数据盘 - -InstanceCreate: - type: object - properties: - name: - type: string - example: test-instance - description: 实例名称 - generate_name: - type: string - example: test-instance-name-duplicate - description: 实例名称(若遇见已存在同名的实例，会自动加上后缀) - keypair: - type: string - example: ebb5abd3-8ffb-42ec-8bc6-38ba5b949885 - description: 秘钥ID或秘钥名称 - password: - type: string - example: Gohci0vo - description: 实例密码 - cdrom: - type: string - example: 70802da8-affe-4247-8ce8-610f205019ca - description: 光盘ID或名称,仅kvm支持，实例启动后会从此光盘启动 - vcpu_count: - type: integer - example: 3 - description: 实例核数 - vga: - type: string - example: std - enum: [std,vmware,cirrus,qxl] - vdi: - type: string - example: vnc - description: VNC协议 - enum: [vnc,spice] - bios: - type: string - example: BIOS - description: 操作系统bios类型 - description: - type: string - example: test-create-instance - description: 实例描述 - boot: - type: string - example: cdrom - description: 启动设备 - enum: [disk,cdrom] - enable_cloud_init: - type: boolean - default: false - example: true - description: 是否启用cloud-init - no_account_init: - type: boolean - default: false - example: true - description: 为true,代表保留镜像设置，不会新设登录密码 - allow_delete: - type: boolean - default: false - example: true - description: 删除保护开启关闭 - shutdown_behavior: - type: string - default: stop - example: terminate - description: 实例关闭后的操作 - enum: [stop, terminate] - auto_start: - type: boolean - default: false - example: true - description: 实例创建后立即启动 - is_system: - type: boolean - default: false - example: true - description: 是否成为系统资源 - duration: - type: string - example: 1D - enum: [1H, 1D, 1W, 1M, 1Y] - description: 包年包月计费周期,仅管理员可用 - eip_bw: - type: integer - example: 10 - description: 新建弹性EIP带宽, 单位Mbps - eip_charge_type: - type: string - example: traffic - enum: [traffic,bandwidth] - description: 新建弹性EIP计费类型 - eip: - type: string - example: bdb1a67f-38b7-4cb0-8676-e56909deec56 - description: 弹性EIP名称或ID，机器创建完成后会自动绑定此EIP - prefer_region: - type: string - example: Default - description: 区域名称或ID(指定调度区域，若此区域资源不足会导致实例创建失败) - prefer_zone: - type: string - example: Zone-1 - description: 可用区名称或ID(指定调度可用区，若此可用区资源不足会导致实例创建失败,此优先级高于prefer_region) - prefer_host: - type: string - example: e621b7c6-cb38-48a3-81bd-1f3a9cc07161 - description: 宿主机名称或ID(指定调度宿主机，若宿主机上资源不足会导致实例创建失败,此优先级高于prefer_zone) - prefix_wire: - type: string - example: 572f250d-5a68-4471-8c1a-02568c7920fb - description: 二层网络名称或ID(指定关联的二层网络,优先级高于prefer_zone) - backup: - type: boolean - default: false - description: 创建实例同时创建备份机, 仅适用于KVM平台 - backup_host: - type: string - example: a44c54d8-9294-475e-8067-c333f3d2fd01 - description: 指定备份机所在的宿主机 - hypervisor: - type: string - example: qcloud - enum: [kvm,esxi,baremetal,container,aliyun,azure,qcloud,aws,huawei,openstack,ucloud,zstack] - description: 指定创建实例平台 - resource_type: - type: string - example: shared - enum: [shared,dedicated,prepaid] - description: | - 指定实例的宿主机资源共享类型 - - - shared，共享型实例 - - dedicated，专属实例 - - prepared，从预付费资源池创建 - schedtag: - type: array - items: - $ref: '#/Schetag' - description: 调度标签列表 - count: - type: integer - default: 1 - description: 批量创建实例个数 - disks: - type: array - items: - $ref: '#/InstanceDisk' - guest_image_id: - type: string - example: 如果使用主机镜像创建主机，需要额外指定主机镜像的 ID，来检验 disks 的 Image ID 是否正确 - groups: - type: array - description: 主机组列表 - items: - type: string - description: 主机组的ID或者Name - secgroups: - type: array - description: 安全组列表 - items: - type: string - example: default - description: 安全组名称或ID,建议使用ID - - -InstanceDisk: - type: object - properties: - index: - type: integer - example: 0 - description: 实例盘索引 - disk_type: - type: string - example: data - enum: [sys,data] - description: 实例盘类型 - backend: - type: string - default: "" - example: local - description: 实例盘后端存储类型 - image_id: - type: string - example: e568a156-1228-4cca-8272-cc7447d0e0ec - description: 系统盘镜像名称或ID - snapshot_id: - type: string - example: 87b789e3-eb82-4b14-8513-c1a241e6f887 - description: 快照名称或ID - size: - type: integer - example: 10240 - description: 实例盘大小，单位MB - fs: - type: string - example: ext4 - description: 磁盘文件系统 - format: - type: string - example: qcow2 - description: 磁盘存储格式 - driver: - type: string - example: virtio - description: 磁盘驱动 - cache: - type: string - example: none - description: 磁盘缓存模式 - mountpoint: - type: string - example: /opt - description: 挂载点 - medium: - type: string - example: ssd - description: 实例盘介质类型 - storage_id: - type: string - example: 6cb2ad27-66a3-4823-83e1-42bcd3080d24 - description: 指定存储 - -Schetag: - type: object - properties: - id: - type: string - example: d75cfa62-6ab6-4154-893a-3142bcb167bc - description: 调度标签ID - strategy: - type: string - example: require - enum: [require,exclude,prefer,avoid] - description: 标签类型 - -InstanceUpdate: - type: object - properties: - name: - type: string - example: other-name - vmem_size: - type: string - example: 2G - vcpu_count: - type: integer - example: 2 - vga: - type: string - example: std - enum: [std,vmware,cirrus,qxl] - vdi: - type: string - example: spice - enum: [vnc,spice] - bios: - type: string - example: UEFI - enum: [BIOS,UEFI] - description: - example: test - type: string - boot: - type: string - example: cdrom - enum: [disk,cdrom] - delete: - type: string - example: disable - enum: [enable,disable] - shutdown_behavior: - type: string - example: terminate - enum: [stop,terminate] - -InstanceSecgroup: - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 安全组ID - name: - type: string - example: Default - description: 安全组名称 - -InstanceDiskInfo: - properties: - aio_mode: - type: string - example: native - description: aio模式 - cache_mode: - type: string - example: none - description: cache模式 - disk_format: - type: string - example: qcow2 - description: 磁盘存储格式 - disk_type: - type: string - example: sys - description: 磁盘类型 sys(系统盘), data(数据盘) - driver: - type: string - example: scsi - description: 磁盘驱动 - image: - type: string - example: centos-6.9-20180414.qcow2 - description: 镜像名称(磁盘根据此镜像创建) - image_id: - type: string - example: 9aad22f9-829c-4d8d-8676-c81a5c7756f2 - description: 镜像ID - index: - type: integer - example: 0 - description: 磁盘索引(实例的第几块盘) - medium_type: - type: string - example: rotate - description: 磁盘介质类型 - size: - type: integer - example: 30720 - description: 磁盘大小，单位Mb - storage_type: - type: string - example: rbd - description: 磁盘后端存储类型 - - -Instance: - type: object - description: 实例 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 实例uuid - readOnly: true - name: - type: string - description: 实例名称 - example: ins-r4hilqks - readOnly: true - billing_type: - type: string - description: 计费类型 - example: postpaid - readOnly: true - account: - type: string - example: office-qcloud - description: 所属云账号名称 - account_id: - type: string - description: 所属云账号ID - bios: - type: string - example: 8ebce595-1a37-473e-8ff8-f02f0b82773d - description: BIOS信息 - boot_order: - type: string - example: cdn - description: 启动顺序 d(磁盘), c(光盘), n(网络) - brand: - type: string - example: DStack - description: 虚拟化品牌 - can_delete: - type: boolean - description: 是否可删除 - can_recycle: - type: boolean - description: 是否可回归资源池 - can_update: - type: boolean - description: 是否可以更新资源属性 - cdrom: - type: string - example: 536a05a9-0b4a-4464-8eaf-dd5eb3c7b553(inserting) - description: 光盘信息 - created_at: - type: string - example: 2019-05-30T02:25:38.000000Z - description: 资源创建时间 - disable_delete: - type: boolean - description: 是否开启删除保护 true(开启), false(关闭) - disk: - type: integer - example: 51200 - description: 磁盘大小(包含系统盘), 单位Mb - external_id: - type: string - example: ins-r4hilqks - description: 实例外部ID，对应的纳管云实例ID - host: - type: string - example: office-qcloud-ap-guangzhou-3 - description: 实例所在的宿主机名称 - host_id: - type: string - example: c767afc9-9175-4ae6-893b-b990c5c128d6 - description: 实例所在的宿主机ID - hypervisor: - type: string - example: qcloud - description: 虚拟化平台或技术 - instance_type: - type: string - example: SN3ne.SMALL2 - description: 实例规格 - ips: - type: string - example: 10.0.42.4 - description: 实例内网IP,若有多个ip, 以 `,` 分隔 - is_emulated: - type: boolean - example: false - description: 是否是虚拟出来的实例 - is_gpu: - type: boolean - example: false - description: GPU实例 - is_system: - type: boolean - example: false - description: 系统资源 - pending_deleted: - type: boolean - example: false - description: 是否在回收站 - keypair_id: - type: string - example: None - description: 实例绑定的秘钥ID - networks: - type: string - example: "eth0:10.168.222.189/24/00:22:dc:df:15:00/1/vnet222/virtio/1000" - description: 网络信息 (网卡/网络索引/ip/网络掩码/mac地址/vlanId/网络名称/网络驱动/网卡带宽), 多个网卡会以换行分隔 - machine: - type: string - example: pc - description: 机器 - manager: - type: string - example: office-qcloud - description: 归属订阅名称 - manager_id: - type: string - example: 30960bb7-4e7b-4df9-8738-b8ceafc99045 - description: 归属订阅ID - manager_project: - type: string - example: system - description: 订阅归属项目名称 - manager_project_id: - type: string - example: 29541006ae9148b9bf002fc294218022 - description: 订阅归属项目ID - os_type: - type: string - example: Linux - description: 实例系统类型 - project_src: - type: string - example: cloud - description: 归属项目同步来源 - provider: - type: string - example: Qcloud - description: 纳管云平台 - region: - type: string - example: 腾讯云 华南地区(广州) - description: 区域名称 - region_ext_id: - type: string - example: ap-guangzhou - description: 区域外部ID,对应纳管云区域ID - region_id: - type: string - example: 13947bd8-569e-4094-8b03-4339c2a8e45b - description: 区域ID - secgroups: - type: array - items: - $ref: '#/InstanceSecgroup' - description: 关联安全组列表 - shutdown_behavior: - type: string - example: stop - description: 关机后操作类型 - status: - type: string - example: running - description: 资源状态 - tenant: - type: string - example: system - description: 归属项目名称 - tenant_id: - type: string - example: 29541006ae9148b9bf002fc294218022 - description: 归属项目ID - update_version: - type: integer - example: 2 - description: 资源被更新的次数 - updated_at: - type: string - example: 2019-05-30T06:36:39.000000Z - description: 资源最近一次更新时间 - vcpu_count: - type: integer - example: 1 - description: 实例CPU核数 - vdi: - type: string - example: vnc - description: vnc连接协议 - vga: - type: string - example: std - description: vga - vmem_size: - type: integer - example: 2048 - description: 实例内存大小, 单位MB - vpc: - type: string - example: test-vpc - description: 虚拟私有网络名称 - vpc_id: - type: string - example: 7712297d-d0eb-4f6d-81e2-c9f768ca8bb6 - description: 虚拟私有网络ID - zone: - type: string - example: 腾讯云 广州三区 - description: 可用区名称 - zone_ext_id: - type: string - example: ap-guangzhou-3 - description: 可用区外部ID,对应纳管云可用区ID - zone_id: - type: string - example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0efc - description: 可用区ID - disks_info: - type: array - items: - $ref: '#/InstanceDiskInfo' - description: 实例盘列表 - disk_count: - type: integer - example: 4 - description: 磁盘数量 - - -InstanceListResponse: - type: object - properties: - limit: - type: integer - example: 20 - servers: - type: array - items: - $ref: '#/Instance' - total: - type: integer - example: 124 -InstanceResponse: - type: object - properties: - server: - type: object - $ref: '#/Instance' - -InstanceVnc: - type: object - description: 实例VNC信息 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 实例uuid - readOnly: true - host: - type: string - description: VNC地址 - example: 192.168.222.4 - readOnly: true - port: - type: integer - description: VNC端口 - example: 5910 - readOnly: true - protocol: - type: integer - description: VNC协议 - example: vnc - -InstanceVncResponse: - type: object - properties: - server: - type: object - $ref: '#/InstanceVnc' - -InstanceBindGroups: - type: object - required: - - group.0 - - group.1 - properties: - group.0: - type: string - example: vv100455-79ef-43a3-8fc3-23adc74b8b87 - description: 主机组的ID或者Name - group.1: - type: string - example: dd100399-79ef-43a3-8fc3-23adc74b8b87 - description: 主机组的ID或者Name diff --git a/docs/schemas/instancegroup.yaml b/docs/schemas/instancegroup.yaml deleted file mode 100644 index 24ec1f2c28..0000000000 --- a/docs/schemas/instancegroup.yaml +++ /dev/null @@ -1,149 +0,0 @@ -CanDelete: - type: string - example: true - description: 可否删除 -CanUpdate: - type: string - example: false - description: 可否更新 -CreatedAt: - type: string - example: 2019-05-30T08:46:12.000000Z - description: 资源创建时间 -UpdatedAt: - type: string - example: 2019-05-30T08:46:12.000000Z - description: 资源最近一次更新时间 - -InstanceGroup: - type: object - description: 实例组 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 实例组ID - readOnly: true - name: - type: string - description: 实例名称 - example: mysql-group - granularity: - type: integer - description: 粒度 - example: 1 - force_dispersion: - type: boolean - description: 是否强制 - example: false - can_delete: - $ref: '#/CanDelete' - can_update: - $ref: '#/CanUpdate' - created_at: - $ref: '#/CreatedAt' - updated_at: - $ref: '#/UpdatedAt' - is_emulated: - type: boolean - example: false - description: 是否是虚拟出来的实例 - status: - type: string - example: init - description: 状态 - update_version: - type: integer - example: 2 - description: 资源被更新的次数 - -InstanceGroupCreate: - type: object - properties: - instancegroup: - type: object - required: - - name - - granularity - - force_dispersion - properties: - name: - type: string - example: mysql-group - description: 实例组的名称 - granularity: - type: integer - description: 粒度 - example: 1 - force_dispersion: - type: boolean - description: 是否强制 - example: false - -InstanceGroupListResponse: - type: object - properties: - limit: - type: integer - example: 20 - total: - type: integer - example: 12 - instancegroups: - type: array - items: - $ref: '#/InstanceGroup' - - -InstanceGroupResponse: - type: object - properties: - instancegroup: - type: object - $ref: '#/InstanceGroup' - -InstanceGroupGuest: - type: object - properties: - guest_id: - type: string - example: f7749379-34b1-4219-8835-257615cf34f6 - description: 主机ID - group_id: - type: string - example: f7749379-34b1-4219-8835-257615cf34f6 - description: 实例组ID - -InstanceGroupGuestResponse: - type: object - properties: - instancegroupGuest: - type: object - $ref: '#/InstanceGroupGuest' - -InstanceGroupGuestListResponse: - type: object - properties: - total: - type: integer - example: 20 - instancegroupGuests: - type: array - items: - $ref: '#/InstanceGroupGuest' - -InstanceGroupBindGuests: - type: object - required: - - guest.0 - - guest.1 - properties: - guest.0: - type: string - example: vv100455-79ef-43a3-8fc3-23adc74b8b87 - description: 主机的ID或者Name - guest.1: - type: string - example: dd100399-79ef-43a3-8fc3-23adc74b8b87 - description: 主机的ID或者Name - diff --git a/docs/schemas/keypair.yaml b/docs/schemas/keypair.yaml deleted file mode 100644 index 1536ce94cf..0000000000 --- a/docs/schemas/keypair.yaml +++ /dev/null @@ -1,90 +0,0 @@ -KeypairCreate: - type: object - properties: - name: - type: string - example: test-keypair - description: 秘钥名称 - description: - type: string - example: keypair-description - description: 秘钥描述 - scheme: - type: string - example: RSA - enum: [RSA, DSA] - default: RSA - description: 秘钥scheme - public_key: - type: string - example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDXxGBcdTPHr2XB2Sr1fknLkRaU3329ltWPjp/vA94QjIGVP98ct0dj/Yu0y2w4t0yqcLSVcZyn0Jo07ErNy9RnvL2F1ecOcg7OgRL+WY3zcOm90RILEQ8/wzUpZmAmTbFSZU7MzPxfdIRyq9UW/qUd/ebX9FD3bq+9HxlJQ9hHAQXyyOJB+Ex4akxOR09ZaVmmIlipa4CHZDfAF4BnXuL+XWAaRnF/xPmUjSTTbsXGV/iKMheexgdJ9zrDycAzA2Qg938fHXpcqHWxdBzcIQ6BEbFNz1RGBAyqPT8l3PNhf+NHSnDufob7y5+bp0z7hvtucujqxOViFhMzAGmtGMZz test@all-in-one - description: 秘钥公钥 - - -KeypairResponse: - type: object - properties: - keypair: - type: object - $ref: '#/Keypair' - -Keypair: - allOf: - - $ref: "./common.yaml#/StandaloneResponse" - - type: object - properties: - scheme: - type: string - example: RSA - enum: [RSA, DSA] - description: 秘钥scheme - publick_key: - type: string - example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDXxGBcdTPHr2XB2Sr1fknLkRaU3329ltWPjp/vA94QjIGVP98ct0dj/Yu0y2w4t0yqcLSVcZyn0Jo07ErNy9RnvL2F1ecOcg7OgRL+WY3zcOm90RILEQ8/wzUpZmAmTbFSZU7MzPxfdIRyq9UW/qUd/ebX9FD3bq+9HxlJQ9hHAQXyyOJB+Ex4akxOR09ZaVmmIlipa4CHZDfAF4BnXuL+XWAaRnF/xPmUjSTTbsXGV/iKMheexgdJ9zrDycAzA2Qg938fHXpcqHWxdBzcIQ6BEbFNz1RGBAyqPT8l3PNhf+NHSnDufob7y5+bp0z7hvtucujqxOViFhMzAGmtGMZz test@all-in-one - description: 公钥 - fingerprint: - type: string - example: f6:54:e2:fe:5e:9d:36:38:bf:30:8a:0f:18:4a:49:81 - description: 私钥 - private_key_len: - type: integer - example: 0 - description: 私钥长度 - linked_guest_count: - type: integer - example: 1 - description: 关联实例数量 - owner_id: - type: string - example: e80d6618-d6a8-4e1c-8646-33949e40bade - description: 所属用户ID - owner_name: - type: string - example: test-user - description: 所属用户名称 - -KeypairListResponse: - type: object - properties: - limit: - type: integer - example: 20 - keypairs: - type: array - items: - $ref: '#/Keypair' - total: - type: integer - example: 124 - -KeypairUpdate: - type: object - properties: - name: - type: string - example: test-keypair - description: 秘钥名称 - description: - type: string - example: keypair-description - description: 秘钥描述 diff --git a/docs/schemas/loadbalancer.yaml b/docs/schemas/loadbalancer.yaml deleted file mode 100644 index 2bea96772d..0000000000 --- a/docs/schemas/loadbalancer.yaml +++ /dev/null @@ -1,762 +0,0 @@ -Loadbalancer: - type: object - description: Loadbalancer实例 - properties: - id: - type: string - description: 实例uuid - readOnly: true - address: - type: string - description: 实例IP地址，即virtual ip - readOnly: true - -LoadbalancerListener: - type: object - description: Loadbalancer监听实例 - properties: - id: - type: string - description: 实例uuid - readOnly: true - loadbalancer_id: - type: string - description: 所属的loadbalancer的uuid - readOnly: true - listener_type: - type: string - description: 监听协议类型 - enum: - - tcp - readOnly: true - listener_port: - type: integer - description: 监听端口，即virtual port - readOnly: true - scheduler: - type: string - description: 调度算法 - readOnly: true - -LoadbalancerListenerRule: - type: object - description: Loadbalancer转发规则实例 - properties: - id: - type: string - description: 实例uuid - readOnly: true - listener_id: - type: string - description: 所属的loadbalancer监听uuid - readOnly: true - domain: - type: string - description: 转发规则匹配的域名 - path: - type: string - description: 转发规则匹配的路径 - backend_group_id: - type: string - description: 转发规则对应的后端服务器组 - -LoadbalancerBackendGroup: - type: object - description: Loadbalancer后端服务器组实例 - properties: - id: - type: string - description: 实例uuid - readOnly: true - loadbalancer_id: - type: string - description: 所属的loadbalancer的uuid - readOnly: true - -LoadbalancerBackend: - type: object - description: Loadbalancer后端实例 - properties: - id: - type: string - description: 实例uuid - readOnly: true - backend_group_id: - type: string - description: 所属的loadbalancer后端服务器组uuid - readOnly: true - backend_type: - type: string - description: 后端服务器类型 - readOnly: true - enum: - - guest - - host - - ip - address: - type: string - description: 后端IP地址，即real ip - readOnly: true - port: - type: string - description: 后端端口，即real port - readOnly: true - weight: - type: integer - description: 后端权重 - -LoadbalancerListResponse: - type: object - properties: - loadbalancers: - type: array - items: - $ref: "#/Loadbalancer" -LoadbalancerResponse: - type: object - properties: - loadbalancer: - type: object - $ref: "#/Loadbalancer" - -LoadbalancerListenerCreateRequest: - type: object - properties: - loadbalancerlistener: - type: object - required: - - loadbalancer - - listener_type - - listener_port - - scheduler - properties: - loadbalancer: - type: string - description: 指定loadbalaner实例uuid - listener_type: - type: string - enum: - - tcp - description: 指定loadbalaner监听协议 - listener_port: - type: integer - description: 指定loadbalaner监听端口 - scheduler: - type: string - description: 指定监听的调度算法 - enum: - - rr - - wrr - - wlc - - sch - - tch - backend_group: - type: string - description: 指定后端服务器组uuid -LoadbalancerListenerListResponse: - type: object - properties: - loadbalancerlisteners: - type: array - items: - $ref: "#/LoadbalancerListener" -LoadbalancerListenerResponse: - type: object - properties: - loadbalancerlistener: - type: object - $ref: "#/LoadbalancerListener" - -LoadbalancerListenerRuleCreateRequest: - type: object - properties: - loadbalancerlistenerrule: - type: object - required: - - listener - - backend_group - properties: - listener: - type: string - description: 所属的loadbalancer监听id - backend_group: - type: string - description: 规则应对的后端服务器组uuid - domain: - type: string - description: 转发规则匹配的域名 - path: - type: string - description: 转发规则匹配的路径 -LoadbalancerListenerRuleListResponse: - type: object - properties: - loadbalancerlistenerrules: - type: array - items: - $ref: "#/LoadbalancerListenerRule" -LoadbalancerListenerRuleResponse: - type: object - properties: - loadbalancer: - type: object - $ref: "#/LoadbalancerListenerRule" - -LoadbalancerBackendGroupListResponse: - type: object - properties: - loadbalancerbackendgroups: - type: array - items: - $ref: "#/LoadbalancerBackendGroup" -LoadbalancerBackendGroupResponse: - type: object - properties: - loadbalancerbackendgroup: - type: object - $ref: "#/LoadbalancerBackendGroup" - -LoadbalancerBackendCreateRequest: - type: object - properties: - loadbalancerbackend: - type: object - required: - - backend_group - - backend_type - - backend - - port - - weight - properties: - backend_group: - type: string - description: 指定loadbalaner后端服务器组uuid - backend_type: - type: string - enum: - - guest - - host - - ip - description: 指定后端服务器的类型。仅管理员能够指定host, ip为后端服务器 - backend: - type: string - description: 后端服务器的标识信息 - - 当backend_type为guest时，该字段的值应当是服务器的uuid - - 当backend_type为host时，该字段的值应为宿主机的uuid - - 当backend_type为ip时，该字段的值应为有效的IP地址 - port: - type: integer - description: 后端服务器的端口 - weight: - type: integer - description: 后端服务器的权重 -LoadbalancerBackendListResponse: - type: object - properties: - loadbalancerbackends: - type: array - items: - $ref: "#/LoadbalancerBackend" -LoadbalancerBackendResponse: - type: object - properties: - loadbalancerbackend: - type: object - $ref: "#/LoadbalancerBackend" - -LoadbalancerAclEntry: - type: object - properties: - cidr: - type: string - example: 192.168.0.1/24 - description: 网段 - readOnly: true - comment: - type: string - description: 注释 - readOnly: true - -LoadbalancerAclEntries: - type: array - items: - $ref: "#/LoadbalancerAclEntry" - -LoadbalancerCachedAclCreateRequest: - type: object - properties: - cachedloadbalanceracl: - type: object - required: - - cloudregion - - cloudprovider - - acl - properties: - cloudregion: - type: string - description: 指定公有云region - cloudprovider: - type: string - description: 指定云账号订阅ID - acl: - type: string - description: 指定需要同步的ACL ID - listener: - type: string - description: 指定负载均衡监听器ID，华为云必须指定该参数。 - -LoadbalancerCachedAcl: - allOf: - - $ref: "./common.yaml#/SharableVirtualResourceBaseResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - properties: - acl_id: - type: string - description: 所属的本地访问控制uuid - acl_entries: - $ref: "#/LoadbalancerAclEntries" - -LoadbalancerCachedAclResponse: - $ref: "#/LoadbalancerCachedAcl" - -LoadbalancerCachedAclListResponse: - type: object - properties: - cached_loadbalancer_acls: - type: array - items: - $ref: "#/LoadbalancerCachedAcl" - -LoadbalancerCachedCertificateCreateRequest: - type: object - properties: - cachedloadbalancercertificate: - type: object - required: - - cloudregion - - cloudprovider - - certificate - properties: - cloudregion: - type: string - description: 指定公有云region - cloudprovider: - type: string - description: 指定云账号订阅ID - certificate: - type: string - description: 指定需要同步的SSL证书 ID - -LoadbalancerCachedCertificateResponse: - allOf: - - $ref: "./common.yaml#/SharableVirtualResourceBaseResponse" - - $ref: "./common.yaml#/ExternalizedResourceBaseResponse" - - type: object - properties: - certificate_id: - type: string - example: ab58813d83284a7f95040901639013d3 - description: 所属的本地证书uuid - readOnly: true - private_key: - type: string - description: 私钥内容 - readOnly: true - publicKey_algorithm: - type: string - description: 公钥算法 - readOnly: true - publicKey_bitLen: - type: integer - description: 公钥长度 - readOnly: true - signature_algorithm: - type: string - description: 签名算法 - readOnly: true - fingerprint: - type: string - example: sha1:da:39:a3:ee:5e:6b:4b:0d:32:55:bf:ef:95:60:18:90:af:d8:07:09 - description: 证书指纹 - readOnly: true - not_before: - type: string - example: 2019-05-23T11:50:33.000000Z - description: 最早生效时间 - readOnly: true - not_after: - type: string - example: 2020-05-23T11:50:33.000000Z - description: 失效时间 - readOnly: true - common_name: - type: string - example: www.onecloud.com - description: 域名 - readOnly: true - subject_alternative_names: - type: string - example: "" - description: 附加域名 - readOnly: true - -LoadbalancerCachedCertificateListResponse: - type: object - properties: - cached_loadbalancercertificates: - type: array - items: - $ref: "#/LoadbalancerCachedCertificateResponse" - -LoadbalancerCluster: - type: object - description: Loadbalancer集群实例 - properties: - id: - type: string - description: 实例uuid - readOnly: true - zone_id: - type: string - description: 集群所在的zone uuid - readOnly: true - -LoadbalancerClusterCreateRequest: - type: object - properties: - loadbalancercluster: - type: object - required: - - zone - properties: - zone: - type: string - description: 指定集群所属的zone uuid -LoadbalancerClusterListResponse: - type: object - properties: - loadbalancerclusters: - type: array - items: - $ref: "#/LoadbalancerCluster" -LoadbalancerClusterResponse: - type: object - properties: - loadbalancercluster: - type: object - $ref: "#/LoadbalancerCluster" - -LoadbalancerAgent: - type: object - description: | - Loadbalancer转发实例 - - - 同cluster中的lbagent - - vrrp virtual_router_id, preempt, pass必须相同 - - vrrp priority必须不同 - - 同zone不同cluster中的lbagent - - vrrp virtual_router_id必须不同 - - 创建时，若不满足以上条件，则创建失败 - - 更新参数时（`params-patch`），同时更新同cluster的peer lbagents - - properties: - id: - type: string - description: 实例uuid - readOnly: true - cluster_id: - type: string - description: 转发实例所属的集群id - readOnly: true - ha_state: - type: string - description: 转发实例的主备状态 - readOnly: true - enum: - - MASTER - - BACKUP - - UNKNOWN - ha_last_seen: - type: string - format: date-time - description: 转发实例上次心跳UTC时间 - readOnly: true - example: "2019-07-24T06:38:07.000000Z" - ha_timeout: - type: integer - description: | - 转发实例心跳超时时间 - - 若上次心跳时间距离当前时间超过此值，则认为实例已离线，进入非活跃状态 - unit: seconds - ip: - type: string - description: 转发实例自上报的IP地址 - readOnly: true - params: - $ref: "#/LoadbalancerAgentParams" - deployment: - $ref: "#/LoadbalancerAgentDeployment" - readOnly: true - loadbalancer_acls: - type: string - format: date-time - description: 转发实例当前同步到的最新LB访问控制对象时戳 - loadbalancer_backend_groups: - type: string - format: date-time - description: 转发实例当前同步到的最新LB后端服务器组对象时戳 - loadbalancer_backends: - type: string - format: date-time - description: 转发实例当前同步到的最新LB后端对象时戳 - loadbalancer_certificates: - type: string - format: date-time - description: 转发实例当前同步到的最新LB证书对象时戳 - loadbalancer_listener_rules: - type: string - format: date-time - description: 转发实例当前同步到的最新LB访问策略对象时戳 - loadbalancer_listeners: - type: string - format: date-time - description: 转发实例当前同步到的最新LB监听对象时戳 - loadbalancers: - type: string - format: date-time - description: 转发实例当前同步到的最新LB对象时戳 - -LoadbalancerAgentDeployment: - type: object - properties: - host: - type: string - ansibleplaybook: - type: string - description: | - 部署对应的ansibleplaybook uuid - - 可通过此字段获取部署的执行结果 - -LoadbalancerAgentParams: - type: object - properties: - vrrp: - $ref: "#/LoadbalancerAgentParamsVrrp" - haproxy: - $ref: "#/LoadbalancerAgentParamsHaproxy" - telegraf: - $ref: "#/LoadbalancerAgentParamsTelegraf" - keepalived_conf_tmpl: - type: string - description: | - 以base64编码的KeepAlived配置模板 - - 创建时可选，服务端会设定默认值 - example: Z2xvYmFsX2RlZnMgewoJcm91dGVyX2lkIHt7IC5hZ2VudC5pZCB9fQoJI3ZycnBfc3RyaWN0Cgl2cnJwX3NraXBfY2hlY2tfYWR2X2FkZHIKCWVuYWJsZV9zY3JpcHRfc2VjdXJpdHkKfQoKdnJycF9pbnN0YW5jZSBZdW5pb25MQiB7CglpbnRlcmZhY2Uge3sgLnZycnAuaW50ZXJmYWNlIH19Cgl2aXJ0dWFsX3JvdXRlcl9pZCB7eyAudnJycC52aXJ0dWFsX3JvdXRlcl9pZCB9fQoJYXV0aGVudGljYXRpb24gewoJCWF1dGhfdHlwZSBQQVNTCgkJYXV0aF9wYXNzIHt7IC52cnJwLnBhc3MgfX0KCX0KCXt7IGlmIC52cnJwLm5vdGlmeV9zY3JpcHQgLX19IG5vdGlmeSB7eyAudnJycC5ub3RpZnlfc2NyaXB0IH19IHJvb3Qge3stIGVuZCB9fQoJe3sgaWYgLnZycnAudW5pY2FzdF9wZWVyIC19fSB1bmljYXN0X3BlZXIgeyB7ey0gcHJpbnRsbiB9fQoJCXt7LSByYW5nZSAudnJycC51bmljYXN0X3BlZXIgfX0JCXt7IHByaW50bG4gLiB9fSB7ey0gZW5kIH19Cgl9Cgl7ey0gZW5kIH19Cglwcmlvcml0eSB7eyAudnJycC5wcmlvcml0eSB9fQoJYWR2ZXJ0X2ludCB7eyAudnJycC5hZHZlcnRfaW50IH19CglnYXJwX21hc3Rlcl9yZWZyZXNoIHt7IC52cnJwLmdhcnBfbWFzdGVyX3JlZnJlc2ggfX0KCXt7IGlmIC52cnJwLnByZWVtcHQgLX19IHByZWVtcHQge3stIGVsc2UgLX19IG5vcHJlZW1wdCB7ey0gZW5kIH19Cgl2aXJ0dWFsX2lwYWRkcmVzcyB7CgkJe3stIHByaW50ZiAiXG4iIH19CgkJe3stIHJhbmdlIC52cnJwLmFkZHJlc3NlcyB9fQkJe3sgcHJpbnRsbiAuIH19IHt7LSBlbmQgfX0KCQl7ey0gcHJpbnRmICJcdCIgLX19Cgl9Cn0K - haproxy_conf_tmpl: - type: string - description: | - 以base64编码的HAProxy配置模板 - - 创建时可选，服务端会设定默认值 - example: Cmdsb2JhbAoJbWF4Y29ubiA0MDk2MAoJdHVuZS5zc2wuZGVmYXVsdC1kaC1wYXJhbSAyMDQ4Cgl7ey0gcHJpbnRsbiB9fQoJe3stIGlmIC5oYXByb3h5Lmdsb2JhbF9zdGF0c19zb2NrZXQgfX0Je3sgcHJpbnRsbiAuaGFwcm94eS5nbG9iYWxfc3RhdHNfc29ja2V0IH19IHt7LSBlbmQgfX0KCXt7LSBpZiAuaGFwcm94eS5nbG9iYWxfbmJ0aHJlYWQgfX0JbmJ0aHJlYWQge3sgcHJpbnRsbiAuaGFwcm94eS5nbG9iYWxfbmJ0aHJlYWQgfX0ge3stIGVuZCB9fQoJe3stIGlmIC5oYXByb3h5Lmdsb2JhbF9sb2cgfX0Je3sgcHJpbnRsbiAuaGFwcm94eS5nbG9iYWxfbG9nIH19IHt7LSBlbmQgfX0KCmRlZmF1bHRzCgl0aW1lb3V0IGNvbm5lY3QgMTBzCgl0aW1lb3V0IGNsaWVudCA2MHMKCXRpbWVvdXQgc2VydmVyIDYwcwoJdGltZW91dCB0dW5uZWwgMWgKCXt7LSBwcmludGxuIH19Cgl7ey0gaWYgLmhhcHJveHkuZ2xvYmFsX2xvZyB9fQl7eyBwcmludGxuICJsb2cgZ2xvYmFsIiB9fSB7ey0gZW5kIH19Cgl7ey0gaWYgbm90IC5oYXByb3h5LmxvZ19ub3JtYWwgfX0Je3sgcHJpbnRsbiAib3B0aW9uIGRvbnRsb2ctbm9ybWFsIiB9fSB7ey0gZW5kIH19CgpsaXN0ZW4gc3RhdHMKCW1vZGUgaHR0cAoJYmluZCA6Nzc4CglzdGF0cyBlbmFibGUKCXN0YXRzIGhpZGUtdmVyc2lvbgoJc3RhdHMgcmVhbG0gIkhhcHJveHkgU3RhdGlzdGljcyIKCXN0YXRzIGF1dGggWXVuaW9uOkxCU3RhdHMKCXN0YXRzIHVyaSAvCg== - telegraf_conf_tmpl: - type: string - description: | - 以base64编码的Telegraf配置模板 - - 创建时可选，服务端会设定默认值 - example: Cltbb3V0cHV0cy5pbmZsdXhkYl1dCgl1cmxzID0gWyJ7eyAudGVsZWdyYWYuaW5mbHV4X2RiX291dHB1dF91cmwgfX0iXQoJZGF0YWJhc2UgPSAie3sgLnRlbGVncmFmLmluZmx1eF9kYl9vdXRwdXRfbmFtZSB9fSIKCWluc2VjdXJlX3NraXBfdmVyaWZ5ID0gdHJ1ZQoKW1tpbnB1dHMuaGFwcm94eV1dCglpbnRlcnZhbCA9ICJ7eyAudGVsZWdyYWYuaGFwcm94eV9pbnB1dF9pbnRlcnZhbCB9fXMiCglzZXJ2ZXJzID0gWyJ7eyAudGVsZWdyYWYuaGFwcm94eV9pbnB1dF9zdGF0c19zb2NrZXQgfX0iXQoJa2VlcF9maWVsZF9uYW1lcyA9IHRydWUK - -LoadbalancerAgentParamsVrrp: - type: object - description: VRRP参数 - properties: - advert_int: - type: integer - description: VRRP通告间隔，单位秒 - mininum: 1 - example: 1 - interface: - type: string - description: VRRP通告发送的网口名 - example: eth0 - garp_master_refresh: - type: integer - description: | - MASTER状态时发送免费ARP通告的最小间隔 - - 单位秒，默认值27，为0时表示不发送通告 - unit: seconds - mininum: 0 - example: 27 - pass: - type: string - description: VRRP通告共享密码 - example: OneCloudLB - preempt: - type: boolean - description: 是否进行抢占式选举 - example: false - priority: - type: integer - description: VRRP实例优先级 - mininum: 1 - maximum: 255 - example: 110 - virtual_router_id: - type: integer - description: VRRP集群ID - mininum: 1 - maximum: 255 - example: 100 -LoadbalancerAgentParamsHaproxy: - type: object - description: HAProxy参数 - properties: - global_log: - type: string - description: HAProxy配置文件global段中关于日志的配置 - example: "log /dev/log local0 info" - global_nbthread: - type: integer - description: HAProxy配置文件global段中关于线程数的配置 - example: 1 - mininum: 1 - maximum: 64 - log_http: - type: boolean - description: 是否记录HTTP访问日志 - log_tcp: - type: boolean - description: 是否记录TCP访问日志 - log_normal: - type: boolean - description: 是否记录结果正常的访问 -LoadbalancerAgentParamsTelegraf: - type: object - description: Telegraf参数 - properties: - haproxy_input_interval: - type: integer - description: HAProxy统计数据的采样间隔 - unit: seconds - minimum: 1 - influx_db_output_name: - type: string - description: 存储监控数据的InfluxDB数据库的名称 - example: "telegraf" - influx_db_output_unsafe_ssl: - type: boolean - description: 访问InfluxDB时是否忽略证书校验 - influx_db_output_url: - type: string - description: InfluxDB的API地址 - example: https://10.168.222.136:8086/ - -LoadbalancerAgentCreateRequest: - type: object - properties: - loadbalanceragent: - type: object - required: - - cluster - properties: - cluster: - type: string - description: 指定转发实例所属的集群 - params: - $ref: "#/LoadbalancerAgentParams" -LoadbalancerAgentListResponse: - type: object - properties: - loadbalanceragents: - type: array - items: - $ref: "#/LoadbalancerAgent" -LoadbalancerAgentResponse: - type: object - properties: - loadbalanceragent: - type: object - $ref: "#/LoadbalancerAgent" - -LoadbalancerAgentDeployRequest: - type: object - properties: - loadbalanceragent: - type: object - properties: - host: - $ref: "./ansibleplaybook.yaml#/AnsiblePlaybookInventoryHost" - deploy_method: - type: string - description: 部署方法 - enum: - - yum - - copy - example: - host: - name: server:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - vars: - user: lbagent - pass: lbagentpassword - proj: system - repo_base_url: https://10.168.222.136/yumrepo - deploy_method: yum - -LoadbalancerBackendStatus: - allOf: - - $ref: '#/LoadbalancerBackend' - - description: 后端及其健康检查状态描述 - properties: - check_time: - type: string - format: date-time - description: 上一次检查时间 - check_code: - type: integer - description: HTTP检查时，报端返回时的http状态码 - check_status: - type: string - description: | - 状态描述 - - { - "UNK": "未知", - "INI": "启动中", - "SOCKERR": "socket错误", - "L4OK": "L4正常", - "L4TOUT": "L4超时", - "L4CON": "L4连接错误", - "L6OK": "L6正常", - "L6TOUT": "L6超时", - "L6RSP": "L6协议错误", - "L7OK": "L7正常", - "L7OKC": "L7正常", - "L7TOUT": "L7超时", - "L7RSP": "L7协议错误", - "L7STS": "L7响应错误" - } - -LoadbalancerListenerBackendStatusResponse: - type: object - properties: - loadbalancerlistener: - type: array - items: - $ref: "#/LoadbalancerBackendStatus" - -LoadbalancerListenerRuleBackendStatusResponse: - type: object - properties: - loadbalancerlistener: - type: array - items: - $ref: "#/LoadbalancerBackendStatus" diff --git a/docs/schemas/natgateway.yaml b/docs/schemas/natgateway.yaml deleted file mode 100644 index 4968173c02..0000000000 --- a/docs/schemas/natgateway.yaml +++ /dev/null @@ -1,380 +0,0 @@ -CanDelete: - type: string - example: true - description: 可否删除 -CanUpdate: - type: string - example: true - description: 可否更新 -CreatedAt: - type: string - example: 2019-05-30T08:46:12.000000Z - description: 资源创建时间 -UpdatedAt: - type: string - example: 2019-05-30T08:46:12.000000Z - description: 资源最近一次更新时间 - -NatGateway: - type: object - description: NAT网关 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: NAT网关ID - readOnly: true - name: - type: string - description: NAT网关名称 - example: nat-jo5pskhg - can_delete: - $ref: '#/CanDelete' - can_update: - $ref: '#/CanUpdate' - cloudregion_id: - type: string - description: 区域ID - example: 609c57b0-a5a7-4a5f-886c-950e1333cbd4 - external_id: - type: string - description: 资源外部ID,对应纳管云上的ID - example: ngw-2zexqebrmyohc1eqly153 - is_emulated: - type: boolean - description: 是否是虚拟资源 - example: false - manager_id: - type: string - description: 对应账号的订阅ID - example: f8f733a6-5db3-42ed-8cde-36bb073ea499 - nat_spec: - type: string - description: NAT网关规格 - example: small - region: - type: string - description: 所属的区域 - example: 阿里云 华北2（北京） - region_ext_id: - type: string - description: 所属区域的外部ID - example: cn-beijing - region_id: - type: string - description: 区域ID - example: f2c9efe0-b743-4de0-84ff-e40e37814ad3 - status: - type: string - description: NAT网关状态 - example: available - updated_at: - $ref: '#/UpdatedAt' - vpc: - type: string - description: 网关VPC的名称 - example: test-vpc - vpc_id: - type: string - description: NAT网关的VPC ID - example: 144bf8aa-782c-48d0-8968-a75fa8aa636a - account: - type: string - description: 云账号名称 - example: office-qcloud - account_id: - type: string - description: 云账号ID - example: 8ebce595-1a37-473e-8ff8-f02f0b82773d - provider: - type: string - description: 云平台类型 - example: Qcloud - -NatGatewayListResponse: - type: object - properties: - limit: - type: integer - example: 20 - natgateways: - type: array - items: - $ref: '#/NatGateway' - total: - type: integer - example: 124 - -NatGatewayResponse: - type: object - properties: - natgateway: - type: object - $ref: '#/NatGateway' - -DNatEntry: - type: object - properties: - id: - type: string - example: 80d8e168-fc51-45f8-8d8d-f072ed27b390 - description: 资源UUID - can_delete: - $ref: '#/CanDelete' - can_update: - $ref: '#/CanUpdate' - created_at: - $ref: '#/CreatedAt' - updated_at: - $ref: '#/UpdatedAt' - external_id: - type: string - example: dnat-2zeqqfcow4t67ahduei7x - description: 资源外部ID,对应纳管云的ID - internal_ip: - type: string - example: 10.0.42.4 - description: 内网IP - internal_port: - type: integer - example: 8080 - description: 内网端口 - external_ip: - type: string - example: 111.230.80.43 - description: 公网IP - external_port: - type: integer - example: 432 - description: 公网端口 - ip_protocol: - type: string - description: 转发协议 - enum: [udp,tcp,any] - example: tcp - name: - type: string - description: DNAT名称(处理过的) - example: hello-ea27c0ce-5870-49f3-8d57-f53e63f40361 - natgateway: - type: string - description: 所属NAT网关名称 - example: test-nat - natgateway_id: - type: string - description: 所属NAT网关ID - example: 609c57b0-a5a7-4a5f-886c-950e1333cbd4 - status: - type: string - description: DNAT状态 - example: available - real_name: - type: string - description: DNAT真实的名称 - example: hello - -DNatEntryListResponse: - type: object - properties: - limit: - type: integer - example: 20 - natdentries: - type: array - items: - $ref: '#/DNatEntry' - total: - type: integer - example: 124 - -DNatEntryResponse: - type: object - properties: - natdentry: - type: object - $ref: '#/DNatEntry' - -SNatEntry: - type: object - properties: - id: - type: string - example: 80d8e168-fc51-45f8-8d8d-f072ed27b390 - description: 资源UUID - can_delete: - $ref: '#/CanDelete' - can_update: - $ref: '#/CanUpdate' - created_at: - $ref: '#/CreatedAt' - updated_at: - $ref: '#/UpdatedAt' - external_id: - type: string - example: snat-2zeqqfcow4t67ahduei7x - description: 资源外部ID,对应纳管云的ID - ip: - type: string - example: 39.96.219.74 - description: 公网IP - name: - type: string - description: SNAT名称（经过处理的） - example: hello-ea27c0ce-5870-49f3-8d57-f53e63f40361 - natgateway: - type: string - example: test-nat - description: 所属NAT网关名称 - natgateway_id: - type: string - example: 4daf9886-ebe6-4a8a-8082-3bd623d1c857 - description: 所属NAT网关ID - network: - $ref: 'network.yaml#/Network' - network_id: - type: string - example: 7caf732e-93fc-42c0-89d2-86aac2970c38 - description: 所属子网ID - source_cidr: - type: string - example: 10.0.0.0/24 - description: 源CIDR - status: - type: string - example: available - description: SNAT状态 - real_name: - type: string - example: hello - description: SNAT真实的名称 - -SNatEntryListResponse: - type: object - properties: - limit: - type: integer - example: 20 - natsentries: - type: array - items: - $ref: '#/SNatEntry' - total: - type: integer - example: 124 - -SNatEntryResponse: - type: object - properties: - natsentry: - type: object - $ref: '#/SNatEntry' - -DNatEntryCreate: - type: object - properties: - natdentry: - type: object - required: - - name - - natgateway_id - - internal_ip - - internal_port - - external_ip - - external_ip_id - - external_port - - ip_protocol - properties: - name: - type: string - example: ones - description: DNat的名字 - natgateway_id: - type: string - example: 378570ec-ded0-4b44-89ed-edce96eb32f7 - description: 所属NAT网关ID - internal_ip: - type: string - example: 10.0.42.4 - description: 内网IP - internal_port: - type: integer - example: 8080 - description: 内网端口 - external_ip: - type: string - example: 111.230.80.43 - description: 公网IP - external_ip_id: - type: string - example: "" - description: 公网IP对应的ID，除了华为云，可以为空 - external_port: - type: integer - example: 432 - description: 公网端口 - ip_protocol: - type: string - description: 转发协议 - enum: [udp,tcp,any] - example: tcp - -SNatEntryCreate: - type: object - properties: - natsentry: - type: object - required: - - name - - natgateway_id - - network_id - - ip - - external_ip_id - - source_cidr - properties: - name: - type: string - example: ones - description: SNat的名字 - natgateway_id: - type: string - example: 378570ec-ded0-4b44-89ed-edce96eb32f7 - description: 所属NAT网关ID - network_id: - type: string - example: 648a6baa-9827-49b1-8831-278a889154a1 - description: 所属网络ID(与source_cidr互斥，只需要传入一个) - ip: - type: string - example: 49.4.12.184 - description: 公网IP - external_ip_id: - type: string - example: "" - description: 公网IP对应的ID - source_cidr: - type: string - example: 192.168.1.0/24 - description: 映射到公网IP的内网网段(和network_id互斥，只需要传入一个） - -DNATResources: - type: object - properties: - eips: - type: array - items: - type: string - example: [34.23.125.45, 23.45.123.56] - -SNATResources: - type: object - properties: - eips: - type: array - items: - type: string - example: [34.23.125.45, 23.45.123.56] - networks: - type: array - items: - type: string - example: [] diff --git a/docs/schemas/network.yaml b/docs/schemas/network.yaml deleted file mode 100644 index 85b613f9f5..0000000000 --- a/docs/schemas/network.yaml +++ /dev/null @@ -1,287 +0,0 @@ -NetworkCreate: - type: object - properties: - name: - type: string - example: test-network - description: 子网名称 - wire: - type: string - example: wire1 - description: ID or Name of wire in which the network created - guest_ip_start: - type: string - example: 10.168.10.100 - description: 子网起始IP - guest_ip_end: - type: string - example: 10.168.10.199 - description: 子网结束IP - guest_ip_mask: - type: string - example: 255.255.255.0 - description: 子网掩码 - guest_gateway: - type: string - example: 10.168.10.1 - description: 网关 - alloc_policy: - type: string - example: none - enmu: [none,stepdown,stepup,random] - description: IP分配策略 - server_type: - type: string - example: guest - enmu: [baremetal,guest,container,pxe,ipmi] - description: 子网分配机器类型 - vlan_id: - type: integer - example: 1 - description: vlan ID - desc: - type: string - example: this is test network - description: 子网描述信息 - guest_dns: - type: string - example: 8.8.8.8 - description: DNS server - guest_domain: - type: string - example: test - description: domain name - guest_dhcp: - type: string - example: 192.168.10.1 - description: DHCP server - -NetworkResponse: - type: object - properties: - network: - type: object - $ref: '#/Network' - -Network: - type: object - description: 网络 - properties: - id: - type: string - example: c427c4ce-6870-19f3-8257-f53e63f40361 - description: 子网uuid - readOnly: true - name: - type: string - description: 子网名称 - example: network-r4hilqks - readOnly: true - brand: - type: string - example: OneCloud - description: 虚拟化品牌 - can_delete: - type: boolean - description: 是否可删除 - can_update: - type: boolean - description: 是否可以更新资源属性 - created_at: - type: string - example: 2019-05-30T02:25:38.000000Z - description: 资源创建时间 - is_emulated: - type: boolean - example: false - description: 是否是虚拟出来的实例 - provider: - type: string - example: OneCloud - description: 纳管云平台 - region: - type: string - example: region1 - description: 区域名称 - region_id: - type: string - example: 13947bd8-569e-4094-8b03-4339c2a8e45b - description: 区域ID - zone: - type: string - example: zone1 - description: 可用区名称 - zone_id: - type: string - example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0efc - description: 可用区ID - update_version: - type: integer - example: 2 - description: 资源被更新的次数 - updated_at: - type: string - example: 2019-05-30T06:36:39.000000Z - description: 资源最近一次更新时间 - status: - type: string - example: available - description: 子网状态 - wire: - type: string - example: bcast0 - description: wire 名称 - wire_id: - type: string - example: 89bb9ccc-c753-432d-96ae-b4c94ca45398 - guest_ip_start: - type: string - example: 10.168.10.100 - description: 子网起始IP - guest_ip_end: - type: string - example: 10.168.10.199 - description: 子网结束IP - guest_ip_mask: - type: string - example: 255.255.255.0 - description: 子网掩码 - guest_gateway: - type: string - example: 10.168.10.1 - description: 网关 - alloc_policy: - type: string - example: none - description: IP分配策略 - server_type: - type: string - example: guest - description: 子网分配机器类型 - vlan_id: - type: integer - example: 1 - description: vlan ID - vpc: - type: string - example: Default - description: vpc Name - vpc_id: - type: string - example: default - description: vpc ID - vnics: - type: integer - example: 10 - description: 网卡数量 - ports: - type: integer - example: 200 - description: 可用IP数量 - used_ports: - type: integer - example: 10 - description: 已经使用IP数量 - -NetworkListResponse: - type: object - properties: - limit: - type: integer - example: 20 - storages: - type: array - items: - $ref: '#/Network' - total: - type: integer - example: 124 - -NetworkUpdate: - type: object - properties: - name: - type: string - example: test-network2 - description: IP子网名称 - guest_ip_end: - type: string - example: 10.168.10.199 - description: 子网结束IP - guest_ip_mask: - type: string - example: 255.255.255.0 - description: 子网掩码 - guest_gateway: - type: string - example: 10.168.10.1 - description: 网关 - alloc_policy: - type: string - example: none - description: IP分配策略 - server_type: - type: string - example: guest - description: 子网分配机器类型 - vlan_id: - type: integer - example: 1 - description: vlan ID - desc: - type: string - example: this is test network - description: 子网描述信息 - guest_dns: - type: string - example: 8.8.8.8 - description: DNS server - guest_domain: - type: string - example: test - description: domain name - guest_dhcp: - type: string - example: 192.168.10.1 - description: DHCP server - -NetworkSplit: - type: object - properties: - split_ip: - type: string - example: 10.168.1.100 - description: 用于分割子网的IP - require: true - name: - type: string - example: new-network - description: new network name - -NetworkMerge: - type: object - properties: - target: - type: string - example: network2 - description: network merge target - -NetworkReserveIp: - type: object - properties: - ips: - type: array - example: ["192.168.10.1","192.168.10.2"] - description: reserve ips - notes: - type: string - example: reserve for test - description: reserve ip notes - -NetworkReleaseReserveIp: - type: object - properties: - ip: - type: string - example: 192.168.10.1 - description: release reserve ip diff --git a/docs/schemas/networkinterface.yaml b/docs/schemas/networkinterface.yaml deleted file mode 100644 index b17bdf5201..0000000000 --- a/docs/schemas/networkinterface.yaml +++ /dev/null @@ -1,44 +0,0 @@ -Networkinterface: - allOf: - - $ref: './common.yaml#/StatusStandaloneResponse' - - $ref: './common.yaml#/ExternalizedResourceBaseResponse' - - type: object - properties: - mac: - type: string - example: fa:16:3e:f4:51:76 - description: 弹性网卡MAC地址 - associate_id: - type: string - example: 1d18dea0-14a4-4d94-8f18-3a827a0cb124 - description: 弹性网卡绑定设备ID - associate_type: - type: string - example: vip - description: 弹性网卡绑定设备类型 - networks: - type: array - items: - $ref: './networkinterfacenetwork.yaml#/NetworkinterfaceNetwork' - -NetworkinterfaceListResponse: - type: object - properties: - limit: - type: integer - example: 20 - networkinterfaces: - type: array - items: - $ref: '#/Networkinterface' - total: - type: integer - example: 124 - - -NetworkinterfaceResponse: - type: object - properties: - networkinterface: - type: object - $ref: '#/Networkinterface' \ No newline at end of file diff --git a/docs/schemas/networkinterfacenetwork.yaml b/docs/schemas/networkinterfacenetwork.yaml deleted file mode 100644 index f64b7bc573..0000000000 --- a/docs/schemas/networkinterfacenetwork.yaml +++ /dev/null @@ -1,45 +0,0 @@ -NetworkinterfaceNetwork: - type: object - properties: - ip_addr: - type: string - example: "192.168.0.240" - description: 弹性网卡IP地址 - network: - type: string - example: test-network - description: 子网名称 - network_id: - type: string - example: 19b09a31-1884-4b3f-84cd-ac03827c567d - description: 弹性网卡所在子网ID - networkinterface_id: - type: string - example: 231aab7c-9106-471a-822c-6dfa605915f7 - description: 弹性网卡ID - primary: - type: boolean - example: true - description: 是否是主IP - -NetworkinterfaceNetworkListResponse: - type: object - properties: - limit: - type: integer - example: 20 - networkinterfacenetworks: - type: array - items: - $ref: '#/NetworkinterfaceNetwork' - total: - type: integer - example: 124 - - -NetworkinterfaceResponse: - type: object - properties: - networkinterfacenetwork: - type: object - $ref: '#/NetworkinterfaceNetwork' diff --git a/docs/schemas/policy.yaml b/docs/schemas/policy.yaml deleted file mode 100644 index fbfb5fdec0..0000000000 --- a/docs/schemas/policy.yaml +++ /dev/null @@ -1,89 +0,0 @@ -PolicyListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - policies: - type: array - items: - $ref: "#/Policy" - -PolicyGetResponse: - type: object - properties: - policy: - type: object - $ref: "#/Policy" - -PolicyPutRequestInput: - type: object - properties: - type: - type: string - description: 权限的名称/类型 - enabled: - type: boolean - description: 启用/禁用权限 - policy: - type: string - description: 权限的json定义 - description: - type: string - description: 权限的描述 - -PolicyCreateInput: - type: object - properties: - type: - type: string - required: true - description: 权限的名称/类型 - enabled: - type: boolean - description: 启用/禁用权限 - policy: - type: string - description: 权限的json定义 - domain: - type: string - description: 权限所属的域 - description: - type: string - description: 项目的描述 - -Policy: - type: object - description: 权限 - properties: - id: - type: string - description: 权限ID - readOnly: true - type: - type: string - description: 权限名称/类型，全局唯一 - can_delete: - type: boolean - description: 是否可以删除 - domain_id: - type: string - descrption: 所属域ID - project_domain: - type: string - description: 所属域名称 - enabled: - type: boolean - description: 是否启用／禁用 - is_public: - type: boolean - description: 是否共享 - policy: - type: string - description: 权限内容的json定义 diff --git a/docs/schemas/project.yaml b/docs/schemas/project.yaml deleted file mode 100644 index 629b6d66d7..0000000000 --- a/docs/schemas/project.yaml +++ /dev/null @@ -1,140 +0,0 @@ -ProjectListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - projects: - type: array - items: - $ref: "#/Project" - -ProjectGetResponse: - type: object - properties: - project: - type: object - $ref: "#/Project" - -ProjectPutRequestInput: - type: object - properties: - name: - type: string - description: 项目的名称 - description: - type: string - description: 项目的描述 - -ProjectCreateInput: - type: object - properties: - name: - type: string - required: true - description: 项目的名称 - description: - type: string - description: 项目的描述 - -Project: - type: object - description: 项目 - properties: - id: - type: string - description: 项目ID - readOnly: true - name: - type: string - description: 项目名，全局唯一 - can_delete: - type: boolean - description: 是否可以删除 - -ProjectJoinRequestInput: - type: object - description: 用户或组批量加入项目的请求body - properties: - projects: - type: array - description: 项目列表 - items: - type: string - roles: - type: array - description: 角色列表 - items: - type: string - -ProjectLeaveRequestInput: - type: object - description: 用户或组批量移除项目的请求body - properties: - project_roles: - type: array - description: 移除的项目和角色列表 - items: - type: object - properties: - project: - type: string - description: 项目ID或名称 - role: - type: string - description: 角色ID或名称 - -ProjectJoinUserGroupRequestInput: - type: object - description: 将多个用户或组批量加入指定项目的请求body - properties: - users: - type: array - description: 加入的用户列表 - items: - type: string - groups: - type: array - description: 加入的组列表 - items: - type: string - roles: - type: array - description: 加入的角色列表 - items: - type: string - -ProjectRemoveUserGroupRequestInput: - type: object - description: 将多个用户或组从指定项目移除的请求body - properties: - user_roles: - type: array - description: 用户和角色列表 - items: - type: object - properties: - user: - type: string - description: 用户ID或名称 - role: - type: string - description: 角色ID或名称 - group_roles: - type: array - description: 组和角色列表 - items: - type: object - properties: - group: - type: string - description: 组ID或名称 - role: - type: string - description: 角色ID或名称 diff --git a/docs/schemas/quota.yaml b/docs/schemas/quota.yaml deleted file mode 100644 index a968627dbf..0000000000 --- a/docs/schemas/quota.yaml +++ /dev/null @@ -1,133 +0,0 @@ -QuotaListResponse: - type: object - properties: - quotas: - type: array - items: - $ref: '#/quota' - -QuotaGetResponse: - type: object - properties: - quotas: - type: object - $ref: '#/quota' - -quota: - type: object - description: 配额信息 - properties: - domain_id: - type: string - description: 在配额列表中，只是当前配额的适用域ID - project_id: - type: string - description: 在配额列表中，只是当前配额的适用项目ID - cpu: - type: integer - description: CPU配额 - memory: - type: integer - description: 内存配额(MB) - storage: - type: integer - description: 虚拟机磁盘配额（MB） - port: - type: integer - description: 内网网口配额（个数） - eip: - type: integer - description: 公网IP配额（个数） - secgroup: - type: integer - description: 安全组配额（个数） - isolated_device: - type: integer - description: 透传设备（GPU）配额 - snapshot: - type: integer - description: 快照配额（个数） - bucket: - type: integer - description: 对象存储存储桶配额（个数） - object_gb: - type: integer - description: 对象存储容量配额（GB） - object_cnt: - type: integer - description: 对象存储个数配额（个数） - image: - type: integer - description: 镜像配额 - usage.cpu: - type: integer - description: CPU使用量 - usage.memory: - type: integer - description: 内存使用量 - usage.storage: - type: integer - description: 虚拟机磁盘使用量（MB） - usage.port: - type: integer - description: 内网网口使用量（个数） - usage.eip: - type: integer - description: 公网IP使用量（个数） - usage.secgroup: - type: integer - description: 安全组使用量（个数） - usage.isolated_device: - type: integer - description: 透传设备（GPU）使用量 - usage.snapshot: - type: integer - description: 快照使用量（个数） - usage.bucket: - type: integer - description: 对象存储存储桶使用量（个数） - usage.object_gb: - type: integer - description: 对象存储容量使用量（GB） - usage.object_cnt: - type: integer - description: 对象存储个数使用量（个数） - usage.image: - type: integer - description: 镜像使用量 - total.cpu: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的CPU配额的总和 - total.memory: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的内存配额的总和 - total.storage: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的虚拟机磁盘配额（MB）的总和 - total.port: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的内网网口配额（个数）的总和 - total.eip: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的公网IP配额（个数）的总和 - total.secgroup: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的安全组配额（个数）的总和 - total.isolated_device: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的透传设备（GPU）配额的总和 - total.snapshot: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的快照配额（个数）的总和 - total.bucket: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的对象存储存储桶配额（个数）的总和 - total.object_gb: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的对象存储容量配额（GB）的总和 - total.object_cnt: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的对象存储个数配额（个数）的总和 - total.image: - type: integer - description: 该字段只有域配额才有，代表该域分配给下属项目的镜像配额的总和 diff --git a/docs/schemas/region.yaml b/docs/schemas/region.yaml deleted file mode 100644 index 28277b7d26..0000000000 --- a/docs/schemas/region.yaml +++ /dev/null @@ -1,67 +0,0 @@ -RegionListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - regions: - type: array - items: - $ref: "#/Region" - -RegionGetResponse: - type: object - properties: - region: - type: object - $ref: "#/Region" - -RegionPutRequestInput: - type: object - properties: - name: - type: string - description: 区域的名称 - description: - type: string - description: 区域的描述 - -RegionCreateInput: - type: object - properties: - id: - type: string - required: true - description: 区域的ID，全局唯一 - example: Beijing, Tianjin - name: - type: string - description: 区域的名称，默认和ID一样，也可以不一样 - example: 北京 - description: - type: string - description: 区域的描述 - -Region: - type: object - description: 区域 - properties: - id: - type: string - description: 区域ID - readOnly: true - name: - type: string - description: 区域名，全局唯一 - can_delete: - type: boolean - description: 是否可以删除 - description: - type: string - description: 区域的描述信息 diff --git a/docs/schemas/role.yaml b/docs/schemas/role.yaml deleted file mode 100644 index 899f45389a..0000000000 --- a/docs/schemas/role.yaml +++ /dev/null @@ -1,62 +0,0 @@ -RoleListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - roles: - type: array - items: - $ref: "#/Role" - -RoleGetResponse: - type: object - properties: - role: - type: object - $ref: "#/Role" - -RolePutRequestInput: - type: object - properties: - description: - type: string - description: 角色的描述 - -RoleCreateInput: - type: object - properties: - name: - type: string - required: true - description: 角色的名称，全局唯一 - description: - type: string - description: 角色的描述 - is_public: - type: boolean - description: 角色是否共享 - -Role: - type: object - description: 角色 - properties: - id: - type: string - description: 角色ID - readOnly: true - name: - type: string - description: 角色名，全局唯一 - can_delete: - type: boolean - description: 是否可以删除 - is_public: - type: boolean - description: 是否共享的角色 diff --git a/docs/schemas/roleassignments.yaml b/docs/schemas/roleassignments.yaml deleted file mode 100644 index 45f6f9688d..0000000000 --- a/docs/schemas/roleassignments.yaml +++ /dev/null @@ -1,99 +0,0 @@ -RoleAssignmentListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - role_assignments: - type: array - items: - $ref: "./roleassignments.yaml#/RoleAssignment" - -RoleAssignment: - type: object - description: RoleAssignment - properties: - scope: - type: object - description: 角色分配的范围 - $ref: './roleassignments.yaml#/Scope' - user: - type: object - description: 角色分配的用户 - $ref: './roleassignments.yaml#/DomainObject' - group: - type: object - description: 角色分配的组 - $ref: './roleassignments.yaml#/DomainObject' - role: - type: object - description: 角色 - $ref: './roleassignments.yaml#/DomainObject' - policies: - type: object - description: 匹配的权限列表 - $ref: './roleassignments.yaml#/PolicyObject' - - -PolicyObject: - type: object - description: 匹配的权限列表 - properties: - project: - type: array - items: - type: string - domain: - type: array - items: - type: string - system: - type: array - items: - type: string - - -Scope: - type: object - description: 角色分配的范围 - properties: - project: - type: object - description: 角色分配关联的项目 - $ref: '#/DomainObject' - domain: - type: object - description: 角色分配的域 - $ref: '#/Domain' - -DomainObject: - type: object - description: 域下的资源，可能为用户，组，项目 - properties: - id: - type: string - description: 资源ID - name: - type: string - description: 资源名称 - domain: - type: object - description: 资源归属的域信息 - $ref: './roleassignments.yaml#/Domain' - -Domain: - type: object - description: 域的信息 - properties: - id: - type: string - description: 域ID - name: - type: string - description: 域名称 diff --git a/docs/schemas/secgroup.yaml b/docs/schemas/secgroup.yaml deleted file mode 100644 index 4b2a71f7ac..0000000000 --- a/docs/schemas/secgroup.yaml +++ /dev/null @@ -1,181 +0,0 @@ -SecgroupCreate: - type: object - properties: - name: - type: string - example: test-secgroup - description: 安全组名称 - description: - type: string - example: secgrou-description - description: 安全组描述 - rules: - type: array - items: - $ref: '#/SecgroupRuleCreate' - -SecgroupRuleCreate: - type: object - properties: - priority: - type: integer - example: 34 - default: 1 - description: 安全组优先级,数字越高，优先级越高 范围 1-100 - protocol: - type: string - example: icmp - enum: [icmp, tcp, udp, any] - requried: true - description: 协议 - ports: - type: string - example: 10-200 - description: 端口或端口范围 - direction: - type: string - example: in - enum: [in, out] - requried: true - description: 规则出入方向 - cidr: - type: string - example: 0.0.0.0/0 - default: "0.0.0.0/0" - description: IP地址或网络地址 - action: - type: string - example: allow - enum: [allow, deny] - requried: true - description: 允许或拒绝 - port_start: - type: integer - example: 10 - description: 和port_end参数配合使用,若指定ports则此参数失效 - port_end: - type: integer - example: 100 - description: 和port_start参数配合使用,若指定ports则此参数失效 - description: - type: string - example: test-description - description: 规则描述信息 - -SecgroupResponse: - type: object - properties: - secgroup: - type: object - $ref: '#/Secgroup' - -Secgroup: - allOf: - - $ref: "./common.yaml#/SharableVirtualResourceBaseResponse" - -SecgroupListResponse: - type: object - properties: - limit: - type: integer - example: 20 - secgroups: - type: array - items: - $ref: '#/Secgroup' - total: - type: integer - example: 124 - -SecgroupUpdate: - type: object - properties: - name: - type: string - example: test-secgroup - description: 安全组名称 - description: - type: string - example: secgrou-description - description: 安全组描述 - -SecgroupClone: - type: object - properties: - name: - type: string - example: test-clone-secgroup - description: 安全组名称 - description: - type: string - example: test-clone-secgroup-description - description: 安全组描述 - -SecgroupUnion: - type: object - properties: - secgroups: - type: array - items: - type: string - description: 待合并的安全组名称或ID列表 - -SecgroupAddRule: - type: object - properties: - priority: - type: integer - example: 10 - min: 1 - max: 100 - description: 规则优先级 - protocol: - type: string - example: tcp - enum: [tcp, udp, icmp, any] - description: 规则协议类型 - ports: - type: string - example: 10-20 - description: 端口，支持单个端口或端口范围 - direction: - type: string - example: in - enum: [in, out] - description: 规则出入方向 - cidr: - type: string - example: 10.10.12.0/24 - description: 规则协议地址 - action: - type: string - example: deny - enum: [allow, deny] - description: 禁止或允许 - description: - type: string - example: test-rule - description: 规则描述 - -SecgroupCache: - type: object - properties: - vpc: - type: string - example: test-vpc - required: true - description: vpc名称或ID,建议使用ID - classic: - type: boolean - default: false - example: false - description: 仅针对支持经典网络的情况,目前仅Azure支持此参数 - -SecgroupUncache: - type: object - properties: - secgroupcache: - type: string - example: 2e974625-d7e2-481b-8471-1c46fa9a65b0 - required: true - description: 安全组缓存ID diff --git a/docs/schemas/secgroupcache.yaml b/docs/schemas/secgroupcache.yaml deleted file mode 100644 index b003e97ade..0000000000 --- a/docs/schemas/secgroupcache.yaml +++ /dev/null @@ -1,67 +0,0 @@ -SecgroupCacheResponse: - type: object - properties: - secgroupcache: - type: object - $ref: '#/SecgroupCache' - -SecgroupCache: - allOf: - - $ref: "./common.yaml#/StatusStandaloneResponse" - - type: object - properties: - vpc_id: - type: string - example: normal - description: 云上的vpc_id,若返回normal一般是指此安全组是region级别的 - secgroup_id: - type: string - example: a9ee32d4-66f3-4d2d-89b7-b1dea778484c - desciption: 本地安全组ID - account: - type: string - example: openstack - description: 资源所属的云账号名称 - account_id: - type: string - example: a9ee32d4-66f3-4d2d-89b7-b1dea778484c - desciption: 源所属的云账号ID - account_domain: - type: string - example: Default - description: 资源账号所属的域 - account_domain_id: - type: string - example: default - description: 资源账号所属的域ID - external_id: - type: string - example: a359d7d6-54b7-4853-b200-9e4a9cfc5f42 - description: 安全组对应云上的ID - manager: - type: string - example: openstack - desciption: 安全组所属的子账号ID - provider: - type: string - example: OpenStack - description: 所属云平台 - region: - type: string - example: openstack-RegionOne - desciption: 所在区域 - - -SecgroupCacheListResponse: - type: object - properties: - limit: - type: integer - example: 20 - secgroupcaches: - type: array - items: - $ref: '#/SecgroupCache' - total: - type: integer - example: 124 diff --git a/docs/schemas/secgrouprule.yaml b/docs/schemas/secgrouprule.yaml deleted file mode 100644 index f3d4694c8f..0000000000 --- a/docs/schemas/secgrouprule.yaml +++ /dev/null @@ -1,132 +0,0 @@ -SecgroupRuleCreate: - type: object - properties: - priority: - type: integer - example: 10 - min: 1 - max: 100 - description: 规则优先级 - protocol: - type: string - example: tcp - enum: [tcp, udp, icmp, any] - description: 规则协议类型 - ports: - type: string - example: 10-20 - description: 端口，支持单个端口或端口范围 - direction: - type: string - example: in - enum: [in, out] - description: 规则出入方向 - cidr: - type: string - example: 10.10.12.0/24 - description: 规则协议地址 - action: - type: string - example: deny - enum: [allow, deny] - description: 禁止或允许 - description: - type: string - example: test-rule - secgroup: - type: string - example: test-secgroup - required: true - description: 安全组名称或ID - -SecgroupRuleResponse: - type: object - properties: - secgrouprule: - type: object - $ref: '#/SecgroupRule' - -SecgroupRule: - type: object - properties: - id: - type: string - example: 37617a8d-0265-4385-8002-2ad685bd2024 - description: 安全组规则ID - priority: - type: integer - example: 10 - description: 规则优先级 - protocol: - type: string - example: tcp - description: 规则协议类型 - ports: - type: string - example: 10-20 - description: 端口，支持单个端口或端口范围 - direction: - type: string - example: in - description: 规则出入方向 - cidr: - type: string - example: 10.10.12.0/24 - description: 规则协议地址 - action: - type: string - example: deny - description: 禁止或允许 - description: - type: string - example: test-rule - -SecgroupRuleListResponse: - type: object - properties: - limit: - type: integer - example: 20 - secgrouprules: - type: array - items: - $ref: '#/SecgroupRule' - total: - type: integer - example: 124 - -SecgroupRuleUpdate: - type: object - properties: - priority: - type: int - example: 10 - min: 1 - max: 100 - description: 规则优先级 - protocol: - type: string - example: tcp - enum: [tcp, udp, icmp, any] - description: 规则协议类型 - ports: - type: string - example: 10-20 - description: 端口，支持单个端口或端口范围 - direction: - type: string - example: in - enum: [in, out] - description: 规则出入方向 - cidr: - type: string - example: 10.10.12.0/24 - description: 规则协议地址 - action: - type: string - example: deny - enum: [allow, deny] - description: 禁止或允许 - description: - type: string - example: test-rule diff --git a/docs/schemas/serversku.yaml b/docs/schemas/serversku.yaml deleted file mode 100644 index 749d4a4bac..0000000000 --- a/docs/schemas/serversku.yaml +++ /dev/null @@ -1,155 +0,0 @@ -ServerSku: - allOf: - - $ref: './common.yaml#/StatusStandaloneResponse' - - $ref: './common.yaml#/ExternalizedResourceBaseResponse' - - type: object - properties: - attached_disk_count: - type: integer - example: 1 - description: 挂载的磁盘数量 - attached_disk_size_gb: - type: integer - example: 0 - description: 挂载的磁盘大小 - cloudregion_id: - type: string - example: default - description: 所属区域的ID - cpu_core_count: - type: integer - example: 1 - description: CPU核数 - data_disk_max_count: - type: integer - example: 0 - description: 最多挂载数据盘数量 - gpu_attachable: - type: boolean - example: true - description: 是否可挂载GPU卡 - gpu_count: - type: integer - example: 0 - description: GPU卡数量 - gpu_max_count: - type: integer - example: 0 - description: 最多可挂载的GPU卡数量 - instance_type_category: - type: string - example: general_purpose - enum: [general_purpose,burstable,compute_optimized,memory_optimized,storage_optimized,hardware_accelerated,high_storage,high_memory] - description: 套餐类型 - instance_type_family: - type: string - example: g1 - description: 套餐族 - local_category: - type: string - example: general_purpose - description: 本地IDC套餐类型 - memory_size_mb: - type: integer - example: 1024 - description: 内存大小 - nic_max_count: - type: integer - example: 1 - description: 最多绑定网卡数量 - os_name: - type: string - example: Any - description: 允许的操作系统 - postpaid_status: - type: string - example: available - enum: [available,soldout] - description: 后付费套餐可用状态 - prepaid_status: - type: string - example: available - enum: [available,soldout] - description: 预付费套餐可用状态 - sys_disk_max_size_gb: - type: integer - example: 0 - description: 系统盘最大容量 - sys_disk_min_size_gb: - type: integer - example: 0 - description: 系统盘最小容量 - sys_disk_resizable: - type: boolean - example: true - description: 系统是否可扩容 - sys_disk_type: - type: string - example: local - description: 系统盘类型 - provider: - type: string - example: OpenStack - description: 套餐平台 - - -ServerSkuListResponse: - type: object - properties: - limit: - type: integer - example: 20 - serverskus: - type: array - items: - $ref: '#/ServerSku' - total: - type: integer - example: 124 - - -ServerSkuResponse: - type: object - properties: - serversku: - type: object - $ref: '#/ServerSku' - -ServerSkuCreate: - type: object - properties: - name: - type: string - example: test-instance - description: 套餐名称 - cloudregion: - type: string - example: RegionOne - description: 套餐所处区域 - default: default - zone: - type: string - example: Zone1 - description: 可用区名称或ID - cpu_core_count: - type: integer - min: 1 - max: 256 - example: 1 - description: CPU核数 - memory_size_mb: - type: integer - min: 512 - max: 524288 - example: 1024 - description: 内存大小 - instance_type_category: - type: string - default: general_purpose - example: general_purpose - enum: [general_purpose,burstable,compute_optimized,memory_optimized,storage_optimized,hardware_accelerated,high_storage,high_memory] - description: 套餐类型 - - required: - - cpu_core_count - - memory_size_mb diff --git a/docs/schemas/service.yaml b/docs/schemas/service.yaml deleted file mode 100644 index 54d7803fa2..0000000000 --- a/docs/schemas/service.yaml +++ /dev/null @@ -1,84 +0,0 @@ -ServiceListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - services: - type: array - items: - $ref: "#/Service" - -ServiceGetResponse: - type: object - properties: - service: - type: object - $ref: "#/Service" - -ServicePutRequestInput: - type: object - properties: - name: - type: string - description: 服务的名称 - example: keystone, region, glance, ... - type: - type: string - description: 服务的类型 - example: identity, compute, image, ... - description: - type: string - description: 服务的描述 - enabled: - type: boolean - description: 是否启用／禁用服务 - -ServiceCreateInput: - type: object - properties: - name: - type: string - description: 服务的名称，全局唯一 - example: keystone - type: - type: string - description: 服务的类型 - example: identity - enabled: - type: boolean - description: 服务是否启用／禁用 - default: true - description: - type: string - description: 服务的描述 - -Service: - type: object - description: 服务 - properties: - id: - type: string - description: 服务ID - readOnly: true - name: - type: string - description: 服务名，全局唯一 - type: - type: string - description: 服务类型 - enabled: - type: boolean - description: 服务是否启用／禁用 - can_delete: - type: boolean - description: 是否可以删除 - description: - type: string - description: 服务的描述信息 diff --git a/docs/schemas/snapshotpolicy.yaml b/docs/schemas/snapshotpolicy.yaml deleted file mode 100644 index c650b97815..0000000000 --- a/docs/schemas/snapshotpolicy.yaml +++ /dev/null @@ -1,206 +0,0 @@ -CanDelete: - type: string - example: true - description: 可否删除 -CanUpdate: - type: string - example: false - description: 可否更新 -CreatedAt: - type: string - example: 2019-05-30T08:46:12.000000Z - description: 资源创建时间 -UpdatedAt: - type: string - example: 2019-05-30T08:46:12.000000Z - description: 资源最近一次更新时间 - -SnapshotPolicy: - type: object - description: 自动快照策略 - properties: - id: - type: string - example: ea27c0ce-5870-49f3-8d57-f53e63f40361 - description: 自动快照策略ID - readOnly: true - name: - type: string - description: 自动快照策略名称 - example: snapshotpolicy-jo5pskhg - retention_days: - type: integer - example: 10 - description: 快照保存的时间(-1为永久保存) - repeat_weekdays: - type: array - items: - type: integer - example: [1, 2] - description: 做快照的时间(每周的周几) - time_points: - type: array - items: - type: integer - example: [2] - description: 做快照的时间(每天的几点) - is_activated: - type: boolean - example: true - description: 是否启用快照策略 - binding_disk_count: - type: integer - example: 3 - description: 自动快照策略绑定的磁盘数量 - can_delete: - $ref: '#/CanDelete' - can_update: - $ref: '#/CanUpdate' - created_at: - $ref: '#/CreatedAt' - updated_at: - $ref: '#/UpdatedAt' - is_emulated: - type: boolean - example: false - description: 是否是虚拟出来的实例 - status: - type: string - example: init - description: 状态 - update_version: - type: integer - example: 2 - description: 资源被更新的次数 - -SnapshotPolicyCreate: - type: object - properties: - snapshotpolicy: - type: object - required: - - name - - retention_days - - repeat_weekdays - - time_points - - is_activated - properties: - name: - type: string - example: snapshotpolicy-jo5pskhg - description: 自动快照策略名称 - retention_days: - type: integer - example: 10 - description: 快照保存的时间(-1为永久保存) - repeat_weekdays: - type: array - items: - type: integer - example: [1, 2] - description: 做快照的时间(每周的周几) - time_points: - type: array - items: - type: integer - example: [2] - description: 做快照的时间(每天的几点) - is_activated: - type: boolean - example: true - description: 是否启用快照策略 - -SnapshotPolicyListResponse: - type: object - properties: - limit: - type: integer - example: 20 - total: - type: integer - example: 12 - snapshotpolicies: - type: array - items: - $ref: '#/SnapshotPolicy' - - -SnapshotPolicyResponse: - type: object - properties: - snapshotpolicy: - type: object - $ref: '#/SnapshotPolicy' - -SnapshotPolicyDisk: - type: object - properties: - can_delete: - $ref: '#/CanDelete' - can_update: - $ref: '#/CanUpdate' - created_at: - $ref: '#/CreatedAt' - updated_at: - $ref: '#/UpdatedAt' - status: - type: string - example: init - description: 状态 - snapshotpolicy_id: - type: string - example: -be8b-4f0f-8885-797930266c6539210785 - description: 自动快照策略ID - disk_id: - type: string - example: f7749379-34b1-4219-8835-257615cf34f6 - description: 磁盘ID - disk: - $ref: 'disk.yaml#/Disk' - -SnapshotPolicyDiskResponse: - type: object - properties: - snapshotpolicydisk: - type: object - $ref: '#/SnapshotPolicyDisk' - -SnapshotPolicyDiskListResponse: - type: object - properties: - total: - type: integer - example: 20 - snapshotpolicydisks: - type: array - items: - $ref: '#/SnapshotPolicyDisk' - -SnapshotPolicyBindDisk: - type: object - required: - - disk.0 - properties: - disk.0: - type: string - example: vv100455-79ef-43a3-8fc3-23adc74b8b87 - description: 待绑定的disk的ID - disk.1: - type: string - example: dd100399-79ef-43a3-8fc3-23adc74b8b87 - description: 待绑定的disk的ID - -SnapshotPolicyCache: - type: object - required: - - region_id - - provider_id - properties: - region_id: - type: string - example: d2ea8591-68b2-4066-802d-c896d1828417 - description: Region ID - provider_id: - type: string - example: 42fde9ca-8642-4318-8c84-2ead0bdc78d2 - description: Provider ID diff --git a/docs/schemas/storage.yaml b/docs/schemas/storage.yaml deleted file mode 100644 index c144f4d814..0000000000 --- a/docs/schemas/storage.yaml +++ /dev/null @@ -1,245 +0,0 @@ -StorageCreate: - type: object - properties: - name: - type: string - example: test-storage - description: 存储名称 - zone: - type: string - example: zone1 - description: 区域名称或ID - medium_type: - type: string - example: ssd - enum: [ssd,rotate] - description: 介质类型 - capacity: - type: integer - example: 10240 - description: 存储容量(单位MB) - storage_type: - type: string - example: local - enum: [local,nas,vsan,rbd,nfs,gpfs,baremetal] - description: 存储集群类型 - rbd_mon_host: - type: string - example: 10.127.10.230,10.127.10.237,10.127.10.238 - description: Ceph mon_host config, 仅存储类型是rbd时有用 - rbd_key: - type: string - example: AQDigB9dtnDAKhAAxS6X4zi4BPR/lIle4nf4Dw== - description: Ceph key config, 仅存储类型是rbd时有用 - rbd_pool: - type: string - example: test-pool - description: Ceph pool name, 仅存储类型是rbd时有用 - rbd_rados_mon_op_timeout: - type: string - example: 10 - default: 5 - description: Ceph集群连接超时时间, 仅存储类型是rbd时有用 - rbd_rados_osd_op_timeout: - type: string - example: 3600 - default: 1200 - description: Ceph块存储操作超时时间, 仅存储类型是rbd时有用 - rbd_client_mount_timeout: - type: string - example: 60 - default: 120 - description: CephFS挂载超时时间, 仅存储类型是rbd时有用 - nfs_host: - type: string - description: NFS host address - nfs_share_dir: - type: string - description: NFS shared dir - -StorageResponse: - type: object - properties: - storage: - type: object - $ref: '#/Storage' - -Storage: - type: object - description: 存储 - properties: - id: - type: string - example: f227c4ce-6870-19f3-8257-f53e63f40361 - description: 存储uuid - readOnly: true - name: - type: string - description: 存储名称 - example: storage-r4hilqks - readOnly: true - brand: - type: string - example: OneCloud - description: 虚拟化品牌 - can_delete: - type: boolean - description: 是否可删除 - can_update: - type: boolean - description: 是否可以更新资源属性 - created_at: - type: string - example: 2019-05-30T02:25:38.000000Z - description: 资源创建时间 - is_emulated: - type: boolean - example: false - description: 是否是虚拟出来的存储 - provider: - type: string - example: Qcloud - description: 纳管云平台 - region: - type: string - example: region1 - description: 区域名称 - region_id: - type: string - example: 13947bd8-569e-4094-8b03-4339c2a8e45b - description: 区域ID - zone: - type: string - example: zone1 - description: 可用区名称 - zone_id: - type: string - example: a16d3e0b-3fd6-45ec-8b2d-e51a51fa0efc - description: 可用区ID - update_version: - type: integer - example: 2 - description: 资源被更新的次数 - updated_at: - type: string - example: 2019-05-30T06:36:39.000000Z - description: 资源最近一次更新时间 - status: - type: string - example: offline - description: 存储状态 - medium_type: - type: string - example: ssd - description: 介质类型 - capacity: - type: integer - example: 10240 - description: 存储容量(单位MB) - storage_type: - type: string - example: local - description: 存储集群类型 - free_capacity: - type: integer - example: 10240 - description: 剩余存储容量(单位MB) - cmtbound: - type: float - example: 1.000000 - description: 超售比 - commit_bound: - type: float - example: 1.000000 - description: 超售比 - commit_rate: - type: float - example: 0.000000 - description: 已分配比率 - is_sys_disk_store: - type: boolean - example: false - description: 系统盘存储 - reserved: - type: integer - example: 1024 - description: 预留存储大小 - storagecache_id: - type: string - example: 7cf5c609-6435-4ef6-8845-882946aeb1a7 - description: 缓存ID - virtual_capacity: - type: integer - example: 201456 - description: 虚拟容量大小 - waste_capacity: - type: integer - example: 12345 - description: 已使用容量大小 - enable: - type: boolean - example: true - description: 存储是否可用 - desc: - type: string - example: this is test storage - description: 存储描述信息 - -StorageListResponse: - type: object - properties: - limit: - type: integer - example: 20 - storages: - type: array - items: - $ref: '#/Storage' - total: - type: integer - example: 124 - - -StorageUpdate: - type: object - properties: - name: - type: string - example: test-storage - description: 存储名称 - storage_type: - type: string - example: local - enum: [local,nas,vsan,rbd,nfs,gpfs,baremetal] - description: 存储集群类型 - medium_type: - type: string - example: ssd - description: 介质类型 - commit_bound: - type: float - example: 1.000000 - description: 超售比 - reserved: - type: integer - example: 1024 - description: 预留存储大小 - desc: - type: string - example: this is test storage - description: 存储描述信息 - rbd_key: - type: string - description: Ceph key config - rbd_rados_mon_op_timeout: - type: string - example: 10 - description: Ceph集群连接超时时间 - rbd_rados_osd_op_timeout: - type: string - example: 3600 - description: Ceph块存储操作超时时间 - rbd_client_mount_timeout: - type: string - example: 60 - description: CephFS挂载超时时间 diff --git a/docs/schemas/storagecache.yaml b/docs/schemas/storagecache.yaml deleted file mode 100644 index 741f5f420b..0000000000 --- a/docs/schemas/storagecache.yaml +++ /dev/null @@ -1,56 +0,0 @@ -StorageCacheResponse: - type: object - properties: - storagecache: - type: object - $ref: '#/StorageCache' - -StorageCache: - type: object - description: 存储缓存 - properties: - id: - type: string - example: f227c4ce-6870-19f3-8257-f53e63f40361 - description: 存储缓存uuid - readOnly: true - name: - type: string - description: 存储h缓存名称 - example: storage-r4hilqks - readOnly: true - is_emulated: - type: boolean - example: false - description: 是否是虚拟出来的缓存 - update_version: - type: integer - example: 2 - description: 资源被更新的次数 - updated_at: - type: string - example: "2019-05-30T06:36:39.000000Z" - description: 资源最近一次更新时间 - external_id: - type: string - example: f27b21ea-514e-4933-8ff5-4bf0c261873a-Huawei/ap-southeast-1 - description: 外部id - path: - type: string - example: /vmfs/volumes/5a017148-0fa691a9-6b8a-0022b70cc59e/image_cache - description: 镜像存储位置 - -StorageCacheListResponse: - type: object - properties: - limit: - type: integer - example: 20 - storagecachess: - type: array - items: - $ref: '#/StorageCache' - total: - type: integer - example: 124 - diff --git a/docs/schemas/user.yaml b/docs/schemas/user.yaml deleted file mode 100644 index 892b81bcd4..0000000000 --- a/docs/schemas/user.yaml +++ /dev/null @@ -1,74 +0,0 @@ -UserListResponse: - type: object - properties: - limit: - type: integer - example: 20 - offset: - type: integer - example: 0 - total: - type: integer - description: 总量 - users: - type: array - items: - $ref: "#/User" - -UserGetResponse: - type: object - properties: - user: - type: object - $ref: "#/User" - -UserPutRequestInput: - type: object - properties: - name: - type: string - description: 用户的名称 - description: - type: string - description: 用户的描述 - -UserCreateInput: - type: object - properties: - name: - type: string - required: true - description: 用户的名称 - password: - type: string - description: 本地用户的密码 - description: - type: string - description: 用户的描述 - -User: - type: object - description: 用户 - properties: - id: - type: string - description: 用户ID - readOnly: true - name: - type: string - description: 用户名，域内唯一 - can_delete: - type: boolean - description: 是否可以删除 - idp_id: - type: string - description: 如果该用户为从认证源导入，则idp_id为该认证源的ID - idp: - type: string - description: 如果该用户为从认证源导入，则idp为该认证源的name - idp_driver: - type: string - description: 如果该用户为从认证源导入，则idp_driver为该认证源的driver - idp_entity_id: - type: string - description: 如果该用户为从认证源导入，则idp_entity_id为该域对应资源的原始ID diff --git a/docs/secgroup/add-rule.yaml b/docs/secgroup/add-rule.yaml deleted file mode 100644 index 33f38081a4..0000000000 --- a/docs/secgroup/add-rule.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 添加安全组规则 - parameters: - - $ref: '../parameters/secgroup.yaml#/secgroupId' - - in: body - name: secgroup - required: true - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupAddRule' - responses: - 200: - description: 安全组信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups \ No newline at end of file diff --git a/docs/secgroup/cache-secgroup.yaml b/docs/secgroup/cache-secgroup.yaml deleted file mode 100644 index 25cb7e9b7e..0000000000 --- a/docs/secgroup/cache-secgroup.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 预创建安全组到云上 - parameters: - - $ref: '../parameters/secgroup.yaml#/secgroupId' - - in: body - name: secgroup - required: true - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupCache' - responses: - 200: - description: 安全组信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups diff --git a/docs/secgroup/clone.yaml b/docs/secgroup/clone.yaml deleted file mode 100644 index 87a10b9f87..0000000000 --- a/docs/secgroup/clone.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 克隆安全组及安全组下面的规则 - parameters: - - $ref: '../parameters/secgroup.yaml#/secgroupId' - - in: body - name: secgroup - required: true - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupClone' - responses: - 200: - description: 安全组信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups \ No newline at end of file diff --git a/docs/secgroup/private.yaml b/docs/secgroup/private.yaml deleted file mode 100644 index ae652daaf0..0000000000 --- a/docs/secgroup/private.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 取消安全组共享 - parameters: - - $ref: "../parameters/secgroup.yaml#/secgroupId" - responses: - 200: - description: 安全组信息 - schema: - $ref: "../schemas/secgroup.yaml#/SecgroupResponse" - - tags: - - secgroups diff --git a/docs/secgroup/public.yaml b/docs/secgroup/public.yaml deleted file mode 100644 index 3a28158c2c..0000000000 --- a/docs/secgroup/public.yaml +++ /dev/null @@ -1,14 +0,0 @@ -post: - summary: 共享安全组 - parameters: - - $ref: "../parameters/secgroup.yaml#/secgroupId" - - $ref: "../parameters/secgroup.yaml#/scope" - - $ref: "../parameters/secgroup.yaml#/shared_projects" - responses: - 200: - description: 安全组信息 - schema: - $ref: "../schemas/secgroup.yaml#/SecgroupResponse" - - tags: - - secgroups diff --git a/docs/secgroup/secgroup.yaml b/docs/secgroup/secgroup.yaml deleted file mode 100644 index 1eafd4c29c..0000000000 --- a/docs/secgroup/secgroup.yaml +++ /dev/null @@ -1,39 +0,0 @@ -get: - summary: 获取指定安全组详情信息 - parameters: - - $ref: '../parameters/secgroup.yaml#/secgroupId' - responses: - 200: - description: 安全组信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups - -delete: - summary: 删除指定安全组 - parameters: - - $ref: '../parameters/secgroup.yaml#/secgroupId' - responses: - 200: - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups - -put: - summary: 更新安全组信息 - parameters: - - $ref: '../parameters/secgroup.yaml#/secgroupId' - - in: body - name: secgroup - required: true - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupUpdate' - responses: - 200: - description: 安全组信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups \ No newline at end of file diff --git a/docs/secgroup/secgroups.yaml b/docs/secgroup/secgroups.yaml deleted file mode 100644 index fbd6e1c09a..0000000000 --- a/docs/secgroup/secgroups.yaml +++ /dev/null @@ -1,28 +0,0 @@ -post: - summary: 创建安全组 - parameters: - - in: body - name: secgroup - required: true - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupCreate' - responses: - 200: - description: 新建安全组的信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups - -get: - summary: 按指定条件列出安全组列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - responses: - 200: - description: 安全组列表信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupListResponse' - tags: - - secgroups diff --git a/docs/secgroup/uncache-secgroup.yaml b/docs/secgroup/uncache-secgroup.yaml deleted file mode 100644 index a94de15b66..0000000000 --- a/docs/secgroup/uncache-secgroup.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 删除云上的某个安全组 - parameters: - - $ref: '../parameters/secgroup.yaml#/secgroupId' - - in: body - name: secgroup - required: true - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupUncache' - responses: - 200: - description: 安全组信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups diff --git a/docs/secgroup/union.yaml b/docs/secgroup/union.yaml deleted file mode 100644 index f256995246..0000000000 --- a/docs/secgroup/union.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 合并安全组 - parameters: - - $ref: '../parameters/secgroup.yaml#/secgroupId' - - in: body - name: secgroup - required: true - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupUnion' - responses: - 200: - description: 安全组信息 - schema: - $ref: '../schemas/secgroup.yaml#/SecgroupResponse' - tags: - - secgroups \ No newline at end of file diff --git a/docs/secgroupcache/secgroupcache.yaml b/docs/secgroupcache/secgroupcache.yaml deleted file mode 100644 index 938e421a46..0000000000 --- a/docs/secgroupcache/secgroupcache.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定安全组缓存详情信息 - parameters: - - $ref: '../parameters/secgroupcache.yaml#/cacheId' - responses: - 200: - description: 安全组信息 - schema: - $ref: '../schemas/secgroupcache.yaml#/SecgroupCacheResponse' - tags: - - secgroupcaches - -delete: - summary: 删除指定安全组缓存 - parameters: - - $ref: '../parameters/secgroupcache.yaml#/cacheId' - responses: - 200: - schema: - $ref: '../schemas/secgroupcache.yaml#/SecgroupCacheResponse' - tags: - - secgroupcaches diff --git a/docs/secgroupcache/secgroupcaches.yaml b/docs/secgroupcache/secgroupcaches.yaml deleted file mode 100644 index 4166f1cbdc..0000000000 --- a/docs/secgroupcache/secgroupcaches.yaml +++ /dev/null @@ -1,13 +0,0 @@ -get: - summary: 按指定条件列出安全组缓存列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/secgroupcache.yaml#/secgroup' - responses: - 200: - description: 安全组缓存列表信息 - schema: - $ref: '../schemas/secgroupcache.yaml#/SecgroupCacheListResponse' - tags: - - secgroupcaches diff --git a/docs/secgrouprule/secgrouprule.yaml b/docs/secgrouprule/secgrouprule.yaml deleted file mode 100644 index f06ce57ac3..0000000000 --- a/docs/secgrouprule/secgrouprule.yaml +++ /dev/null @@ -1,39 +0,0 @@ -get: - summary: 获取指定安全组规则详情信息 - parameters: - - $ref: "../parameters/secgrouprule.yaml#/secgroupruleId" - responses: - 200: - description: 安全组规则详情信息 - schema: - $ref: "../schemas/secgrouprule.yaml#/SecgroupRuleResponse" - tags: - - secgroups - -delete: - summary: 删除指定安全组规则 - parameters: - - $ref: '../parameters/secgrouprule.yaml#/secgroupruleId' - responses: - 200: - schema: - $ref: '../schemas/secgrouprule.yaml#/SecgroupRuleResponse' - tags: - - secgroups - -put: - summary: 更新安全组规则信息 - parameters: - - $ref: '../parameters/secgrouprule.yaml#/secgroupruleId' - - in: body - name: secgroup - required: true - schema: - $ref: '../schemas/secgrouprule.yaml#/SecgroupRuleUpdate' - responses: - 200: - description: 安全组规则信息 - schema: - $ref: '../schemas/secgrouprule.yaml#/SecgroupRuleResponse' - tags: - - secgroups \ No newline at end of file diff --git a/docs/secgrouprule/secgrouprules.yaml b/docs/secgrouprule/secgrouprules.yaml deleted file mode 100644 index f0c5c9a34e..0000000000 --- a/docs/secgrouprule/secgrouprules.yaml +++ /dev/null @@ -1,29 +0,0 @@ -post: - summary: 创建安全组规则 - parameters: - - in: body - name: secgrouprule - required: true - schema: - $ref: '../schemas/secgrouprule.yaml#/SecgroupRuleCreate' - responses: - 200: - description: 新建安全组规则的信息 - schema: - $ref: '../schemas/secgrouprule.yaml#/SecgroupRuleResponse' - tags: - - secgroups - -get: - summary: 按指定条件列出安全组规则列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/secgrouprule.yaml#/secgroup' - responses: - 200: - description: 安全组规则信息 - schema: - $ref: '../schemas/secgrouprule.yaml#/SecgroupRuleListResponse' - tags: - - secgroups \ No newline at end of file diff --git a/docs/server.py b/docs/server.py deleted file mode 100644 index 91600823b5..0000000000 --- a/docs/server.py +++ /dev/null @@ -1,14 +0,0 @@ -#!/usr/bin/env python - -from SimpleHTTPServer import SimpleHTTPRequestHandler -import BaseHTTPServer - - -class CORSRequestHandler (SimpleHTTPRequestHandler): - def end_headers(self): - self.send_header('Access-Control-Allow-Origin', '*') - SimpleHTTPRequestHandler.end_headers(self) - - -if __name__ == '__main__': - BaseHTTPServer.test(CORSRequestHandler, BaseHTTPServer.HTTPServer) diff --git a/docs/serversku/cache-sku.yaml b/docs/serversku/cache-sku.yaml deleted file mode 100644 index a680d65ea0..0000000000 --- a/docs/serversku/cache-sku.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 缓存本地套餐到私有云上 - parameters: - - $ref: "../parameters/serversku.yaml#/serverskuId" - responses: - 200: - description: 缓存的实例套餐信息 - schema: - $ref: "../schemas/serversku.yaml#/ServerSkuResponse" - - tags: - - serverskus diff --git a/docs/serversku/disable.yaml b/docs/serversku/disable.yaml deleted file mode 100644 index 43e9dd7a31..0000000000 --- a/docs/serversku/disable.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 禁用实例套餐 - parameters: - - $ref: "../parameters/serversku.yaml#/serverskuId" - responses: - 200: - description: 禁用的实例套餐信息 - schema: - $ref: "../schemas/serversku.yaml#/ServerSkuResponse" - - tags: - - serverskus diff --git a/docs/serversku/enable.yaml b/docs/serversku/enable.yaml deleted file mode 100644 index 85c164e5c0..0000000000 --- a/docs/serversku/enable.yaml +++ /dev/null @@ -1,12 +0,0 @@ -post: - summary: 启用实例套餐 - parameters: - - $ref: "../parameters/serversku.yaml#/serverskuId" - responses: - 200: - description: 启用的实例套餐信息 - schema: - $ref: "../schemas/serversku.yaml#/ServerSkuResponse" - - tags: - - serverskus diff --git a/docs/serversku/serversku.yaml b/docs/serversku/serversku.yaml deleted file mode 100644 index ad43d8092b..0000000000 --- a/docs/serversku/serversku.yaml +++ /dev/null @@ -1,23 +0,0 @@ -get: - summary: 获取指定套餐详情信息 - parameters: - - $ref: "../parameters/serversku.yaml#/serverskuId" - responses: - 200: - description: 套餐详情信息 - schema: - $ref: "../schemas/serversku.yaml#/ServerSkuResponse" - tags: - - serverskus - -delete: - summary: 删除指定套餐(仅本地套餐可删除) - parameters: - - $ref: '../parameters/serversku.yaml#/serverskuId' - - $ref: '../parameters/serversku.yaml#/purge' - responses: - 200: - schema: - $ref: "../schemas/serversku.yaml#/ServerSkuResponse" - tags: - - serverskus diff --git a/docs/serversku/serverskus.yaml b/docs/serversku/serverskus.yaml deleted file mode 100644 index b762407e7f..0000000000 --- a/docs/serversku/serverskus.yaml +++ /dev/null @@ -1,35 +0,0 @@ -get: - summary: 按指定条件列出实例套餐 - parameters: - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/cloud_env" - - $ref: "../parameters/common.yaml#/cloudregion" - - $ref: "../parameters/common.yaml#/zone" - - $ref: "../parameters/common.yaml#/city" - - $ref: "../parameters/serversku.yaml#/provider" - - $ref: "../parameters/serversku.yaml#/memory_size_mb" - - $ref: "../parameters/serversku.yaml#/usable" - responses: - 200: - description: 实例套餐列表信息 - schema: - $ref: "../schemas/serversku.yaml#/ServerSkuListResponse" - tags: - - serverskus -post: - summary: 创建实例套餐 - parameters: - - in: body - name: serversku - required: true - schema: - $ref: "../schemas/serversku.yaml#/ServerSkuCreate" - responses: - 200: - description: 新创建的实例套餐信息 - schema: - $ref: "../schemas/serversku.yaml#/ServerSkuResponse" - - tags: - - serverskus diff --git a/docs/snapshotpolicy/bind-disk.yaml b/docs/snapshotpolicy/bind-disk.yaml deleted file mode 100644 index e9cff33f4d..0000000000 --- a/docs/snapshotpolicy/bind-disk.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 批量绑定磁盘 - parameters: - - $ref: '../parameters/snapshotpolicy.yaml#/snapshotpolicyId' - - in: body - name: disks - required: true - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyBindDisk' - responses: - 200: - description: 自动快照策略 - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyResponse' - tags: - - snapshotpolicy \ No newline at end of file diff --git a/docs/snapshotpolicy/cache.yaml b/docs/snapshotpolicy/cache.yaml deleted file mode 100644 index e524c50377..0000000000 --- a/docs/snapshotpolicy/cache.yaml +++ /dev/null @@ -1,17 +0,0 @@ -post: - summary: 将本地的自动快照策略同步到云上 - parameters: - - $ref: '../parameters/snapshotpolicy.yaml#/snapshotpolicyId' - - in: body - name: snapshotpolicy - required: true - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyCache' - responses: - 200: - description: 自动快照策略 - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyResponse' - tags: - - snapshotpolicy - diff --git a/docs/snapshotpolicy/snapshotpolicies.yaml b/docs/snapshotpolicy/snapshotpolicies.yaml deleted file mode 100644 index cccdbc2606..0000000000 --- a/docs/snapshotpolicy/snapshotpolicies.yaml +++ /dev/null @@ -1,32 +0,0 @@ -get: - summary: 按指定条件列出快照策略 - parameters: - - $ref: "../parameters/common.yaml#/offset" - - $ref: "../parameters/common.yaml#/limit" - - $ref: "../parameters/snapshotpolicy.yaml#/retention_days" - - $ref: "../parameters/snapshotpolicy.yaml#/repeat_weekdays" - - $ref: "../parameters/snapshotpolicy.yaml#/time_points" - - responses: - 200: - description: 快照策略列表信息 - schema: - $ref: "../schemas/snapshotpolicy.yaml#/SnapshotPolicyListResponse" - tags: - - snapshotpolicy - -post: - summary: 创建自动快照策略 - parameters: - - in: body - name: snapshotpolicy - required: true - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyCreate' - responses: - 200: - description: 新建自动快照策略的信息 - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyResponse' - tags: - - snapshotpolicy diff --git a/docs/snapshotpolicy/snapshotpolicy.yaml b/docs/snapshotpolicy/snapshotpolicy.yaml deleted file mode 100644 index 787914d86a..0000000000 --- a/docs/snapshotpolicy/snapshotpolicy.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - summary: 获取指定自动快照策略信息 - parameters: - - $ref: "../parameters/snapshotpolicy.yaml#/snapshotpolicyId" - responses: - 200: - description: 自动快照策略信息 - schema: - $ref: "../schemas/snapshotpolicy.yaml#/SnapshotPolicyResponse" - tags: - - snapshotpolicy - -delete: - summary: 删除指定自动快照 - parameters: - - $ref: '../parameters/snapshotpolicy.yaml#/snapshotpolicyId' - responses: - 200: - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyResponse' - tags: - - snapshotpolicy diff --git a/docs/snapshotpolicy/snapshotpolicydisk.yaml b/docs/snapshotpolicy/snapshotpolicydisk.yaml deleted file mode 100644 index c75e9b0975..0000000000 --- a/docs/snapshotpolicy/snapshotpolicydisk.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 列出指定磁盘下所有绑定的自动快照策略 - parameters: - - $ref: '../parameters/snapshotpolicy.yaml#/diskId' - responses: - 200: - description: 自动快照策略ID列表 - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyDiskListResponse' - tags: - - snapshotpolicy diff --git a/docs/snapshotpolicy/snapshotpolicydisk2.yaml b/docs/snapshotpolicy/snapshotpolicydisk2.yaml deleted file mode 100644 index 8e84ce04ef..0000000000 --- a/docs/snapshotpolicy/snapshotpolicydisk2.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 列出指定自动快照策略所有绑定的磁盘 - parameters: - - $ref: '../parameters/snapshotpolicy.yaml#/snapshotpolicyId' - responses: - 200: - description: 自动快照策略ID列表 - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyDiskListResponse' - tags: - - snapshotpolicy diff --git a/docs/snapshotpolicy/snapshotpolicydisk3.yaml b/docs/snapshotpolicy/snapshotpolicydisk3.yaml deleted file mode 100644 index 5d98955b2c..0000000000 --- a/docs/snapshotpolicy/snapshotpolicydisk3.yaml +++ /dev/null @@ -1,23 +0,0 @@ -post: - summary: 绑定指定磁盘和自动快照策略 - parameters: - - $ref: '../parameters/snapshotpolicy.yaml#/diskId' - - $ref: '../parameters/snapshotpolicy.yaml#/snapshotpolicyId' - responses: - 200: - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyDiskResponse' - tags: - - snapshotpolicy - -delete: - summary: 解绑指定磁盘和自动快照策略 - parameters: - - $ref: '../parameters/snapshotpolicy.yaml#/diskId' - - $ref: '../parameters/snapshotpolicy.yaml#/snapshotpolicyId' - responses: - 200: - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyDiskResponse' - tags: - - snapshotpolicy \ No newline at end of file diff --git a/docs/snapshotpolicy/unbind-disk.yaml b/docs/snapshotpolicy/unbind-disk.yaml deleted file mode 100644 index b8ab408786..0000000000 --- a/docs/snapshotpolicy/unbind-disk.yaml +++ /dev/null @@ -1,16 +0,0 @@ -post: - summary: 批量解绑磁盘 - parameters: - - $ref: '../parameters/snapshotpolicy.yaml#/snapshotpolicyId' - - in: body - name: disks - required: true - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyBindDisk' - responses: - 200: - description: 自动快照策略 - schema: - $ref: '../schemas/snapshotpolicy.yaml#/SnapshotPolicyResponse' - tags: - - snapshotpolicy diff --git a/docs/storage/storage.yaml b/docs/storage/storage.yaml deleted file mode 100644 index 06a4fac1dc..0000000000 --- a/docs/storage/storage.yaml +++ /dev/null @@ -1,91 +0,0 @@ -get: - summary: 获取指定存储详情信息 - parameters: - - $ref: '../parameters/storage.yaml#/storageId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/storage.yaml#/StorageResponse' - tags: - - storages - -delete: - summary: 删除指定存储 - parameters: - - $ref: '../parameters/storage.yaml#/storageId' - responses: - 200: - schema: - $ref: '../schemas/storage.yaml#/StorageResponse' - tags: - - storages - -put: - summary: 更新存储信息 - parameters: - - $ref: '../parameters/storage.yaml#/storageId' - - in: body - name: storage - required: true - schema: - $ref: '../schemas/storage.yaml#/StorageUpdate' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/storage.yaml#/StorageResponse' - tags: - - storages - -enable: - post: - summary: 使存储可用 - parameters: - - $ref: '../parameters/storage.yaml#/storageId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/storage.yaml#/StorageResponse' - tags: - - storages - -disable: - post: - summary: 使存储不可用 - parameters: - - $ref: '../parameters/storage.yaml#/storageId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/storage.yaml#/StorageResponse' - tags: - - storages - -online: - post: - summary: 使存储在线 - parameters: - - $ref: '../parameters/storage.yaml#/storageId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/storage.yaml#/StorageResponse' - tags: - - storages - -offline: - post: - summary: 使存储离线 - parameters: - - $ref: '../parameters/storage.yaml#/storageId' - responses: - 200: - description: 实例信息 - schema: - $ref: '../schemas/storage.yaml#/StorageResponse' - tags: - - storages diff --git a/docs/storage/storages.yaml b/docs/storage/storages.yaml deleted file mode 100644 index d7717312e2..0000000000 --- a/docs/storage/storages.yaml +++ /dev/null @@ -1,34 +0,0 @@ -post: - summary: 创建存储集群 - parameters: - - in: body - name: storage - required: true - schema: - $ref: '../schemas/storage.yaml#/StorageCreate' - responses: - 200: - description: 新建存储的信息 - schema: - $ref: '../schemas/storage.yaml#/StorageResponse' - tags: - - storages - -get: - summary: 按指定条件列出存储集群 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/zone' - - $ref: '../parameters/common.yaml#/region' - - $ref: '../parameters/common.yaml#/brand' - - $ref: '../parameters/storage.yaml#/share' - - $ref: '../parameters/storage.yaml#/local' - - $ref: '../parameters/storage.yaml#/usable' - responses: - 200: - description: 存储列表信息 - schema: - $ref: '../schemas/storage.yaml#/StorageListResponse' - tags: - - storages diff --git a/docs/storagecache/cache-image.yaml b/docs/storagecache/cache-image.yaml deleted file mode 100644 index e99aa028bb..0000000000 --- a/docs/storagecache/cache-image.yaml +++ /dev/null @@ -1,14 +0,0 @@ -post: - summary: 缓存镜像到此存储缓存上 - parameters: - - $ref: "../parameters/storagecache.yaml#/storagecacheId" - - $ref: "../parameters/storagecache.yaml#/image" - - $ref: "../parameters/storagecache.yaml#/is_force" - - $ref: "../parameters/storagecache.yaml#/format" - responses: - 200: - description: 存储缓存信息 - schema: - $ref: "../schemas/storagecache.yaml#/StorageCacheResponse" - tags: - - storagecaches diff --git a/docs/storagecache/storagecache.yaml b/docs/storagecache/storagecache.yaml deleted file mode 100644 index ee6d2a80d6..0000000000 --- a/docs/storagecache/storagecache.yaml +++ /dev/null @@ -1,11 +0,0 @@ -get: - summary: 获取指定存储缓存详情信息 - parameters: - - $ref: '../parameters/storagecache.yaml#/storagecacheId' - responses: - 200: - description: 存储缓存详情信息 - schema: - $ref: '../schemas/storagecache.yaml#/StorageCacheResponse' - tags: - - storagecaches diff --git a/docs/storagecache/storagecaches.yaml b/docs/storagecache/storagecaches.yaml deleted file mode 100644 index cf8f4c2225..0000000000 --- a/docs/storagecache/storagecaches.yaml +++ /dev/null @@ -1,19 +0,0 @@ -get: - summary: 按指定条件列出存储缓存列表 - parameters: - - $ref: '../parameters/common.yaml#/limit' - - $ref: '../parameters/common.yaml#/offset' - - $ref: '../parameters/common.yaml#/cloudprovider' - - $ref: '../parameters/common.yaml#/cloudaccount' - - $ref: '../parameters/common.yaml#/provider' - - $ref: '../parameters/common.yaml#/brand' - - $ref: '../parameters/common.yaml#/cloud_env' - - $ref: '../parameters/common.yaml#/is_on_premise' - - $ref: '../parameters/common.yaml#/is_managed' - responses: - 200: - description: 存储缓存列表信息 - schema: - $ref: '../schemas/storagecache.yaml#/StorageCacheListResponse' - tags: - - storagecaches diff --git a/docs/swagger/index.html b/docs/swagger/index.html new file mode 100644 index 0000000000..485ce1081d --- /dev/null +++ b/docs/swagger/index.html @@ -0,0 +1,150 @@ + + + + Swagger UI + + + + + + + + + + + + + + diff --git a/docs/swagger/swagger_cloudevent.yaml b/docs/swagger/swagger_cloudevent.yaml new file mode 100644 index 0000000000..7aaed817ca --- /dev/null +++ b/docs/swagger/swagger_cloudevent.yaml @@ -0,0 +1,1491 @@ +basePath: / +consumes: +- application/json +definitions: + CloudeventDetails: + properties: + account: + type: string + x-go-name: Account + action: + type: string + x-go-name: Action + brand: + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudprovider_id: + type: string + x-go-name: CloudproviderId + created_at: + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + domain_id: + description: 域Id + type: string + x-go-name: DomainId + event_id: + format: int64 + type: integer + x-go-name: EventId + manager: + type: string + x-go-name: Manager + name: + type: string + x-go-name: Name + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + type: string + x-go-name: Provider + request: + type: object + x-go-name: Request + request_id: + type: string + x-go-name: RequestId + resource_type: + type: string + x-go-name: ResourceType + service: + type: string + x-go-name: Service + success: + type: boolean + x-go-name: Success + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudevent + EnabledStatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + EnabledStatusStandaloneResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + EnabledStatusStandaloneResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ModelBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ModelBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TTagSet: + items: + $ref: '#/definitions/STag' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils +host: '"127.0.0.1:8889"' +info: + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Cloudevent API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" +paths: + /cloudevents: + get: + description: 列表 + operationId: cloudevent_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 服务类型 + in: query + items: + type: string + name: service + type: array + x-go-name: Service + - description: 订阅 + in: query + items: + type: string + name: manager + type: array + x-go-name: Manager + - description: 账号 + in: query + items: + type: string + name: account + type: array + x-go-name: Account + - description: 操作类型 + in: query + items: + type: string + name: action + type: array + x-go-name: Action + - description: 资源类别 + in: query + items: + type: string + name: resource_type + type: array + x-go-name: ResourceType + - description: 执行状态 + in: query + name: success + type: boolean + x-go-name: Success + - description: 操作日志起始时间 + format: date-time + in: query + name: since + type: string + x-go-name: Since + - description: 操作日志截止时间 + format: date-time + in: query + name: until + type: string + x-go-name: Until + responses: + "200": + $ref: '#/responses/cloudevent_ListItemFilterOutput' + summary: 云平台操作日志列表 + tags: + - cloudevent + post: + description: 新建 + operationId: cloudevent_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudevent: + $ref: '#/definitions/ModelBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudevent_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudevent + /cloudevents/{id}: + delete: + description: 删除 + operationId: cloudevent_CustomizeDelete + parameters: + - description: The Id or Name of cloudevent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudevent_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudevent + get: + description: 获取详情 + operationId: cloudevent_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudevent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudevent_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudevent + put: + description: 更新 + operationId: cloudevent_ValidateUpdateData + parameters: + - description: The Id or Name of cloudevent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudevent: + $ref: '#/definitions/ModelBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudevent_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudevent + /cloudevents/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudevent_GetPropertyDistinctField + parameters: + - in: query + items: + type: string + name: Field + type: array + - in: query + items: + type: string + name: ExtraField + type: array + responses: + "200": + $ref: '#/responses/cloudevent_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudevent + /cloudevents/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudevent_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudevent: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudevent_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudevent + /cloudevents/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudevent_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudevent_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudevent + /cloudevents/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudevent_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudevent_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudevent + /cloudproviders: + get: + description: 列表 + operationId: cloudprovider_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/cloudprovider_ListItemFilterOutput' + summary: 列表 + tags: + - cloudprovider + post: + description: 新建 + operationId: cloudprovider_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudprovider + /cloudproviders/{id}: + delete: + description: 删除 + operationId: cloudprovider_CustomizeDelete + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudprovider + get: + description: 获取详情 + operationId: cloudprovider_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudprovider + put: + description: 更新 + operationId: cloudprovider_ValidateUpdateData + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudprovider + /cloudproviders/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudprovider_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudprovider + post: + description: 执行操作ClassMetadata + operationId: cloudprovider_PerformClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudprovider_PerformDisable + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformDisableOutput' + summary: 禁用资源 + tags: + - cloudprovider + /cloudproviders/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudprovider_PerformEnable + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformEnableOutput' + summary: 启用资源 + tags: + - cloudprovider + /cloudproviders/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudprovider_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudprovider + /cloudproviders/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudprovider_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudprovider_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudprovider + /cloudproviders/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudprovider_GetDetailsStatus + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudprovider + post: + description: 执行操作Status + operationId: cloudprovider_PerformStatus + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudprovider + /cloudproviders/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudprovider_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudprovider + /cloudproviders/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudprovider_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudprovider + /cloudproviders/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudprovider_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudprovider + /cloudproviders/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudprovider_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudprovider + /cloudproviders/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudprovider_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudprovider + /cloudproviders/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudprovider_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudprovider + /cloudproviders/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudprovider_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudprovider +produces: +- application/json +responses: + cloudevent_CustomizeDeleteOutput: + schema: + properties: + cloudevent: + $ref: '#/definitions/CloudeventDetails' + type: object + cloudevent_FetchCustomizeColumnsOutput: + schema: + properties: + cloudevent: + $ref: '#/definitions/CloudeventDetails' + type: object + cloudevent_GetPropertyDistinctFieldOutput: {} + cloudevent_GetPropertySplitableExportOutput: {} + cloudevent_GetPropertySplitableOutput: {} + cloudevent_ListItemFilterOutput: + schema: + properties: + cloudevents: + items: + $ref: '#/definitions/CloudeventDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudevent_PerformPurgeSplitableOutput: {} + cloudevent_ValidateCreateDataOutput: + schema: + properties: + cloudevent: + $ref: '#/definitions/CloudeventDetails' + type: object + cloudevent_ValidateUpdateDataOutput: + schema: + properties: + cloudevent: + $ref: '#/definitions/CloudeventDetails' + type: object + cloudprovider_CustomizeDeleteOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: object + cloudprovider_FetchCustomizeColumnsOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: object + cloudprovider_GetDetailsClassMetadataOutput: + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsMetadataOutput: + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsStatusOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudprovider_GetPropertyDistinctFieldOutput: {} + cloudprovider_GetPropertySplitableExportOutput: {} + cloudprovider_GetPropertySplitableOutput: {} + cloudprovider_GetPropertyStatisticsOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/StatusStatistic' + type: object + cloudprovider_GetPropertyTagValuePairsOutput: {} + cloudprovider_GetPropertyTagValueTreeOutput: {} + cloudprovider_ListItemFilterOutput: + schema: + properties: + cloudproviders: + items: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudprovider_PerformClassMetadataOutput: {} + cloudprovider_PerformDisableOutput: {} + cloudprovider_PerformEnableOutput: {} + cloudprovider_PerformPurgeSplitableOutput: {} + cloudprovider_PerformSetClassMetadataOutput: {} + cloudprovider_PerformSetUserMetadataOutput: {} + cloudprovider_PerformStatusOutput: {} + cloudprovider_ValidateCreateDataOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: object + cloudprovider_ValidateUpdateDataOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/EnabledStatusStandaloneResourceDetails' + type: object +schemes: +- https +- http +securityDefinitions: + keystone: + in: header + name: X-Auth-Token + type: apiKey +swagger: "2.0" diff --git a/docs/swagger/swagger_cloudid.yaml b/docs/swagger/swagger_cloudid.yaml new file mode 100644 index 0000000000..cc5772a02d --- /dev/null +++ b/docs/swagger/swagger_cloudid.yaml @@ -0,0 +1,8809 @@ +basePath: / +consumes: +- application/json +definitions: + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + CloudgroupAddUserInput: + properties: + clouduser_id: + description: 用户Id + type: string + x-go-name: ClouduserId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupAttachPolicyInput: + properties: + cloudpolicy_id: + description: 权限Id + type: string + x-go-name: CloudpolicyId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudpolicy_ids: + description: 权限Id列表, 权限provider必须和权限组provider一致 + items: + type: string + type: array + x-go-name: CloudpolicyIds + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + provider: + description: 平台, 目前支持Qcloud,Google,Azure,Aliyun,Huawei,Aws + type: string + x-go-name: Provider + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupDetachPolicyInput: + properties: + cloudpolicy_id: + description: 权限Id + type: string + x-go-name: CloudpolicyId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudgroupcache_count: + description: 公有云权限组缓存数量 + format: int64 + type: integer + x-go-name: CloudgroupcacheCount + cloudpolicies: + items: + $ref: '#/definitions/SCloudIdBaseResource' + type: array + x-go-name: Cloudpolicies + cloudpolicy_count: + description: 权限数量 + format: int64 + type: integer + x-go-name: CloudpolicyCount + clouduser_count: + description: 公有云子用户数量 + format: int64 + type: integer + x-go-name: ClouduserCount + cloudusers: + items: + $ref: '#/definitions/SCloudIdBaseResource' + type: array + x-go-name: Cloudusers + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupRemoveUserInput: + properties: + clouduser_id: + description: 用户Id + type: string + x-go-name: ClouduserId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupSetPoliciesInput: + properties: + cloudpolicy_ids: + description: 权限Ids + items: + type: string + type: array + x-go-name: CloudpolicyIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupSetUsersInput: + properties: + clouduser_ids: + description: 公有云子账号Ids + items: + type: string + type: array + x-go-name: ClouduserIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudgroupcacheDetails: + properties: + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + cloudgroup_id: + description: 用户组Id + type: string + x-go-name: CloudgroupId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 平台信息 + type: string + x-go-name: Provider + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudpolicyAssignGroupInput: + properties: + cloudgroup_id: + description: 权限组Id + type: string + x-go-name: CloudgroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudpolicyCacheInput: + properties: + manager_id: + description: 云订阅Id + type: string + x-go-name: ManagerId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudpolicyCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloud_env: + type: string + x-go-name: CloudEnv + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + document: + description: 策略详情 + type: object + x-go-name: Document + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + policy_type: + default: custom + type: string + x-go-name: PolicyType + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + provider: + description: 平台 + type: string + x-go-name: Provider + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudpolicyDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + document: + description: 策略内容 + type: object + x-go-name: Document + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + locked: + description: 是否锁定, 若锁定后, 此策略不允许被绑定到用户或权限组, 仅管理员可以设置是否锁定 + type: boolean + x-go-name: Locked + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + policy_type: + description: |- + 权限类型 + 权限类型 | 说明 | + ---------------|----------------------| + system | 平台内置权限 | + custom | 用户自定义权限 | + type: string + x-go-name: PolicyType + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: "平台\n 云平台 | 说明 |\n----------|---------------------------------------------|\n + Google | 支持 |\n Aliyun | 支持\t\t\t\t\t\t\t\t\t\t|\n + Huawei | 支持 |\n Azure | 支持 |\n + 腾讯云 | 支持 |" + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudpolicyRevokeGroupInput: + properties: + cloudgroup_id: + description: 权限组Id + type: string + x-go-name: CloudgroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudpolicyUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + document: + type: object + x-go-name: Document + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudpolicycacheDetails: + properties: + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudprovider: + description: 云订阅名称 + type: string + x-go-name: Cloudprovider + delete_fail_reason: + $ref: '#/definitions/Error' + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + provider: + description: 平台信息 + type: string + x-go-name: Provider + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudroleDetails: + properties: + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + cloudgroup_id: + type: string + x-go-name: CloudgroupId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + document: + type: object + x-go-name: Document + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + owner_id: + type: string + x-go-name: OwnerId + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + saml_provider_id: + type: string + x-go-name: SAMLProviderId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + CloudrolePurgeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserAttachPolicyInput: + properties: + cloudpolicy_id: + description: |- + 权限Id + + + + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 支持 | + Aliyun | 支持 | + Huawei | 不支持 | + Azure | 支持 | + 腾讯云 | 支持 | + type: string + x-go-name: CloudpolicyId + cloudprovider_id: + description: 订阅Id, 向云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效 + type: string + x-go-name: CloudproviderId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserChangeOwnerInput: + properties: + user_id: + description: 本地用户Id + type: string + x-go-name: UserId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserCreateAccessKeyInput: + properties: + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + description: |- + 云账号ID + Azure云账号需要有User administrator权限，否则删操作会出现Insufficient privileges to complete the operation错误信息 + type: string + x-go-name: CloudaccountId + cloudgroup_ids: + description: 初始化权限组Id列表, 权限组必须和云账号平台属性相同 + items: + type: string + type: array + x-go-name: CloudgroupIds + cloudpolicy_ids: + description: |- + 初始的权限Id列表, 权限必须属于指定的云账号 + + + + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 至少需要一个初始权限 | + Aliyun | 支持 | + Huawei | 不支持 | + Azure | 支持 | + 腾讯云 | 支持 | + items: + type: string + type: array + x-go-name: CloudpolicyIds + cloudprovider_id: + description: |- + 云订阅ID, 若此参数为空, 则cloudpolicy_ids的权限会绑定到此账号的所有订阅, 若不为空则cloudpolicy_ids仅绑定的指定的订阅 + 此参数仅对Google,Azure生效 + type: string + x-go-name: CloudproviderId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + email: + description: 邮箱地址 + example: test@example.com + type: string + x-go-name: Email + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_console_login: + default: false + description: 是否可控制台登录 + type: boolean + x-go-name: IsConsoleLogin + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + mobile_phone: + description: 手机号码 + example: 86-1868888**** + type: string + x-go-name: MobilePhone + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + notify: + default: false + description: 是否发送邮件通知(仅设置email不为空生效) + type: boolean + x-go-name: Notify + owner_id: + description: 本地用户Id，若为空则使用当前用户Id作为此参数值 + type: string + x-go-name: OwnerId + password: + description: |- + 用户密码, 若is_console_login = true时, 此参数不传时会生成12位随机密码 + + + + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 不支持此参数 | + Aliyun | 支持 | + Huawei | 支持 | + Azure | 支持 | + 腾讯云 | 支持 | + type: string + x-go-name: Password + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserDeleteAccessKeyInput: + properties: + access_key: + type: string + x-go-name: AccessKey + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserDetachPolicyInput: + properties: + cloudpolicy_id: + description: |- + 权限Id + + + + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 支持，但最少需要保留一个权限 | + Aliyun | 支持 | + Huawei | 不支持 | + Azure | 不支持 | + 腾讯云 | 支持 | + type: string + x-go-name: CloudpolicyId + cloudprovider_id: + description: 订阅Id, 解绑云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效 + type: string + x-go-name: CloudproviderId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserDetails: + properties: + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + cloudgroup_count: + description: 权限组数量 + format: int64 + type: integer + x-go-name: CloudgroupCount + cloudgroups: + items: + $ref: '#/definitions/SCloudIdBaseResource' + type: array + x-go-name: Cloudgroups + cloudpolicies: + items: + $ref: '#/definitions/ClouduserpolicyDetails' + type: array + x-go-name: Cloudpolicies + cloudpolicy_count: + description: 权限数量 + format: int64 + type: integer + x-go-name: CloudpolicyCount + cloudprovider: + description: 云订阅名称 + type: string + x-go-name: Cloudprovider + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + email: + description: 邮箱地址 + type: string + x-go-name: Email + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_console_login: + description: 是否可以控制台登录 + type: boolean + x-go-name: IsConsoleLogin + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mobile_phone: + description: 手机号码 + type: string + x-go-name: MobilePhone + name: + description: 资源名称 + type: string + x-go-name: Name + owner_id: + description: 本地用户Id + type: string + x-go-name: OwnerId + owner_name: + description: 用户名称 + type: string + x-go-name: OwnerName + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + secret: + type: string + x-go-name: Secret + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserJoinGroupInput: + properties: + cloudgroup_id: + description: 权限组Id + type: string + x-go-name: CloudgroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserLeaveGroupInput: + properties: + cloudgroup_id: + description: 权限组Id + type: string + x-go-name: CloudgroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserResetPasswordInput: + properties: + password: + description: |- + 若此参数为空, 默认会生成随机12位密码 + + + + 云平台 | 说明 | + ----------|---------------------------------------------| + Google | 不支持 | + Aliyun | 支持 | + Huawei | 支持 | + Azure | 支持 | + 腾讯云 | 支持 | + type: string + x-go-name: Password + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserSetGroupsInput: + properties: + cloudgroup_ids: + description: 权限组Ids + items: + type: string + type: array + x-go-name: CloudgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserSetPoliciesInput: + properties: + cloudpolicy_ids: + description: 权限Ids + items: + type: string + type: array + x-go-name: CloudpolicyIds + cloudprovider_id: + description: 订阅Id, 设置云账号赋予某个订阅的权限, 目前仅Google,Azure平台此参数生效 + type: string + x-go-name: CloudproviderId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserSyncInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + ClouduserpolicyDetails: + properties: + cloudprovider_id: + description: 子订阅Id + type: string + x-go-name: CloudproviderId + id: + description: 权限Id + type: string + x-go-name: Id + manager: + description: 子订阅名称 + type: string + x-go-name: Manager + name: + description: 权限名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + EnabledStatusInfrasResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformChangeDomainOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicDomainInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SAMLProviderCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + type: string + x-go-name: CloudaccountId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + SAMLProviderDetails: + properties: + auth_url: + type: string + x-go-name: AuthUrl + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + entity_id: + type: string + x-go-name: EntityId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + metadata_document: + type: string + x-go-name: MetadataDocument + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + SCloudIdBaseResource: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + SamluserCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + description: 权限组和账号必须是同一平台 + type: string + x-go-name: CloudaccountId + cloudgroup_id: + description: 权限组和账号必须是同一平台 + type: string + x-go-name: CloudgroupId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + email: + type: string + x-go-name: Email + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + owner_id: + description: 本地用户Id，若为空则使用当前用户Id作为此参数值 + type: string + x-go-name: OwnerId + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + SamluserDetails: + properties: + brand: + description: 品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount: + description: 云账号名称 + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 云账号Id + type: string + x-go-name: CloudaccountId + cloudgroup: + description: 公有云用户名称 + type: string + x-go-name: Cloudgroup + cloudgroup_id: + type: string + x-go-name: CloudgroupId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + email: + description: 邮箱地址 + type: string + x-go-name: Email + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + iam_login_url: + description: 公有云账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + owner_id: + description: 本地用户Id + type: string + x-go-name: OwnerId + owner_name: + description: 用户名称 + type: string + x-go-name: OwnerName + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 平台信息 + type: string + x-go-name: Provider + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudid + SharedDomain: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedProject: + properties: + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusDomainLevelResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusInfrasResourceBaseCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusInfrasResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TTagSet: + items: + $ref: '#/definitions/STag' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils +host: '"127.0.0.1:8889"' +info: + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Cloudid API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" +paths: + /cloudgroupcaches: + get: + description: 列表 + operationId: cloudgroupcache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 根据权限组过滤 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + responses: + "200": + $ref: '#/responses/cloudgroupcache_ListItemFilterOutput' + summary: 公有云权限组缓存 + tags: + - cloudgroupcache + /cloudgroupcaches/{id}: + delete: + description: 删除 + operationId: cloudgroupcache_CustomizeDelete + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroupcache_CustomizeDeleteOutput' + summary: 删除权限组缓存 + tags: + - cloudgroupcache + get: + description: 获取详情 + operationId: cloudgroupcache_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroupcache_FetchCustomizeColumnsOutput' + summary: 获取权限组缓存详情 + tags: + - cloudgroupcache + /cloudgroupcaches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudgroupcache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudgroupcache + post: + description: 执行操作ClassMetadata + operationId: cloudgroupcache_PerformClassMetadata + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroupcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroupcache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudgroupcache + /cloudgroupcaches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudgroupcache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudgroupcache + /cloudgroupcaches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudgroupcache_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroupcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroupcache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudgroupcache + /cloudgroupcaches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudgroupcache_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroupcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroupcache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudgroupcache + /cloudgroupcaches/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudgroupcache_GetDetailsStatus + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudgroupcache + post: + description: 执行操作Status + operationId: cloudgroupcache_PerformStatus + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroupcache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroupcache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudgroupcache + /cloudgroupcaches/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: cloudgroupcache_PerformSyncstatus + parameters: + - description: The Id or Name of cloudgroupcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroupcache: + $ref: '#/definitions/CloudgroupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroupcache_PerformSyncstatusOutput' + summary: 同步权限组缓存状态 + tags: + - cloudgroupcache + /cloudgroupcaches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudgroupcache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudgroupcache + /cloudgroupcaches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudgroupcache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudgroupcache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroupcache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudgroupcache + /cloudgroupcaches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudgroupcache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudgroupcache + /cloudgroupcaches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudgroupcache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudgroupcache + /cloudgroupcaches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudgroupcache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudgroupcache + /cloudgroupcaches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudgroupcache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudgroupcache + /cloudgroupcaches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudgroupcache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudgroupcache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudgroupcache + /cloudgroups: + get: + description: 列表 + operationId: cloudgroup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 过滤子账号所在的权限组 + in: query + name: clouduser_id + type: string + x-go-name: ClouduserId + - description: 根据权限过滤权限组 + in: query + name: cloudpolicy_id + type: string + x-go-name: CloudpolicyId + - description: 是否可用 + in: query + name: usable + type: boolean + x-go-name: Usable + responses: + "200": + $ref: '#/responses/cloudgroup_ListItemFilterOutput' + summary: 权限组列表 + tags: + - cloudgroup + post: + description: 新建 + operationId: cloudgroup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_ValidateCreateDataOutput' + summary: 创建权限组 + tags: + - cloudgroup + /cloudgroups/{id}: + delete: + description: 删除 + operationId: cloudgroup_CustomizeDelete + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_CustomizeDeleteOutput' + summary: 删除权限组 + tags: + - cloudgroup + get: + description: 获取详情 + operationId: cloudgroup_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_FetchCustomizeColumnsOutput' + summary: 获取权限组详情 + tags: + - cloudgroup + put: + description: 更新 + operationId: cloudgroup_ValidateUpdateData + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_ValidateUpdateDataOutput' + summary: 更新权限组 + tags: + - cloudgroup + /cloudgroups/{id}/add-user: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformAddUser + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupAddUserInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformAddUserOutput' + summary: 向权限组加入用户 + tags: + - cloudgroup + /cloudgroups/{id}/attach-policy: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformAttachPolicy + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupAttachPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformAttachPolicyOutput' + summary: 向权限组添加权限 + tags: + - cloudgroup + /cloudgroups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cloudgroup_PerformChangeOwner + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cloudgroup + /cloudgroups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudgroup_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudgroup + /cloudgroups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudgroup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudgroup + post: + description: 执行操作ClassMetadata + operationId: cloudgroup_PerformClassMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudgroup + /cloudgroups/{id}/detach-policy: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformDetachPolicy + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetachPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformDetachPolicyOutput' + summary: 从权限组移除权限 + tags: + - cloudgroup + /cloudgroups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudgroup_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudgroup + /cloudgroups/{id}/private: + post: + description: 执行操作Private + operationId: cloudgroup_PerformPrivate + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cloudgroup + /cloudgroups/{id}/public: + post: + description: 执行操作Public + operationId: cloudgroup_PerformPublic + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformPublicOutput' + summary: 执行操作Public + tags: + - cloudgroup + /cloudgroups/{id}/remove-user: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformRemoveUser + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupRemoveUserInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformRemoveUserOutput' + summary: 从权限组移除用户 + tags: + - cloudgroup + /cloudgroups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudgroup_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudgroup + /cloudgroups/{id}/set-policies: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformSetPolicies + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupSetPoliciesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetPoliciesOutput' + summary: 设置权限组添权限(全量覆盖) + tags: + - cloudgroup + /cloudgroups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudgroup_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudgroup + /cloudgroups/{id}/set-users: + post: + description: '权限组状态必须为: available' + operationId: cloudgroup_PerformSetUsers + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupSetUsersInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSetUsersOutput' + summary: 设置权限组用户(全量覆盖) + tags: + - cloudgroup + /cloudgroups/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudgroup_GetDetailsStatus + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudgroup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudgroup + post: + description: 执行操作Status + operationId: cloudgroup_PerformStatus + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudgroup + /cloudgroups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: cloudgroup_PerformSyncstatus + parameters: + - description: The Id or Name of cloudgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformSyncstatusOutput' + summary: 恢复权限组状态 + tags: + - cloudgroup + /cloudgroups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudgroup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudgroup + /cloudgroups/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: cloudgroup_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - cloudgroup + /cloudgroups/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: cloudgroup_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - cloudgroup + /cloudgroups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudgroup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudgroup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudgroup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudgroup + /cloudgroups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudgroup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudgroup + /cloudgroups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudgroup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudgroup + /cloudgroups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudgroup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudgroup + /cloudgroups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudgroup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudgroup + /cloudgroups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudgroup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudgroup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudgroup + /cloudpolicies: + get: + description: 列表 + operationId: cloudpolicy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 根据子账号过滤权限 + in: query + name: clouduser_id + type: string + x-go-name: ClouduserId + - description: 根据权限组过滤权限 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + - description: 根据订阅过滤权限 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: |- + 权限类型 + + + 类型 | 说明 | + ---------| ------------ | + system | 过滤系统权限 | + custom | 过滤自定义权限 | + in: query + name: policy_type + type: string + x-go-name: PolicyType + - description: 是否显示Locked的权限 + in: query + name: locked + type: boolean + x-go-name: Locked + responses: + "200": + $ref: '#/responses/cloudpolicy_ListItemFilterOutput' + summary: 公有云权限列表 + tags: + - cloudpolicy + post: + description: 新建 + operationId: cloudpolicy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_ValidateCreateDataOutput' + summary: 创建自定义策略 + tags: + - cloudpolicy + /cloudpolicies/{id}: + delete: + description: 删除 + operationId: cloudpolicy_CustomizeDelete + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_CustomizeDeleteOutput' + summary: 删除自定义权限 + tags: + - cloudpolicy + get: + description: 获取详情 + operationId: cloudpolicy_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_FetchCustomizeColumnsOutput' + summary: 获取公有云权限详情 + tags: + - cloudpolicy + put: + description: 更新 + operationId: cloudpolicy_ValidateUpdateData + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_ValidateUpdateDataOutput' + summary: 更新策略(仅限自定义) + tags: + - cloudpolicy + /cloudpolicies/{id}/assign-group: + post: + description: 执行操作AssignGroup + operationId: cloudpolicy_PerformAssignGroup + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyAssignGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformAssignGroupOutput' + summary: 将权限加入权限组 + tags: + - cloudpolicy + /cloudpolicies/{id}/cache: + post: + description: 执行操作Cache + operationId: cloudpolicy_PerformCache + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyCacheInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformCacheOutput' + summary: 缓存自定义权限到云上 + tags: + - cloudpolicy + /cloudpolicies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cloudpolicy_PerformChangeOwner + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cloudpolicy + /cloudpolicies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudpolicy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudpolicy + /cloudpolicies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudpolicy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudpolicy + post: + description: 执行操作ClassMetadata + operationId: cloudpolicy_PerformClassMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudpolicy + /cloudpolicies/{id}/lock: + post: + description: 执行操作Lock + operationId: cloudpolicy_PerformLock + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyAssignGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformLockOutput' + summary: 锁定权限(禁止使用此权限) + tags: + - cloudpolicy + /cloudpolicies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudpolicy_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudpolicy + /cloudpolicies/{id}/private: + post: + description: 执行操作Private + operationId: cloudpolicy_PerformPrivate + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cloudpolicy + /cloudpolicies/{id}/public: + post: + description: 执行操作Public + operationId: cloudpolicy_PerformPublic + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformPublicOutput' + summary: 执行操作Public + tags: + - cloudpolicy + /cloudpolicies/{id}/revoke-group: + post: + description: 执行操作RevokeGroup + operationId: cloudpolicy_PerformRevokeGroup + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyRevokeGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformRevokeGroupOutput' + summary: 将权限从权限组中移除 + tags: + - cloudpolicy + /cloudpolicies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudpolicy_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudpolicy + /cloudpolicies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudpolicy_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudpolicy + /cloudpolicies/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudpolicy_GetDetailsStatus + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicy_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudpolicy + post: + description: 执行操作Status + operationId: cloudpolicy_PerformStatus + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudpolicy + /cloudpolicies/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: cloudpolicy_PerformSyncstatus + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudgroupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformSyncstatusOutput' + summary: 恢复权限组状态 + tags: + - cloudpolicy + /cloudpolicies/{id}/unlock: + post: + description: 执行操作Unlock + operationId: cloudpolicy_PerformUnlock + parameters: + - description: The Id or Name of cloudpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyAssignGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformUnlockOutput' + summary: 解锁权限(允许使用此权限) + tags: + - cloudpolicy + /cloudpolicies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudpolicy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudpolicy + /cloudpolicies/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: cloudpolicy_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - cloudpolicy + /cloudpolicies/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: cloudpolicy_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - cloudpolicy + /cloudpolicies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudpolicy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudpolicy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudpolicy + /cloudpolicies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudpolicy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudpolicy + /cloudpolicies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudpolicy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudpolicy + /cloudpolicies/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudpolicy_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudpolicy + /cloudpolicies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudpolicy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudpolicy + /cloudpolicies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudpolicy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudpolicy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudpolicy + /cloudpolicycaches: + get: + description: 列表 + operationId: cloudpolicycache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据权限过滤 + in: query + name: cloudpolicy_id + type: string + x-go-name: CloudpolicyId + - description: 根据云账号过滤 + in: query + name: cloudaccount_id + type: string + x-go-name: CloudaccountId + responses: + "200": + $ref: '#/responses/cloudpolicycache_ListItemFilterOutput' + summary: 公有云权限缓存列表 + tags: + - cloudpolicycache + post: + description: 新建 + operationId: cloudpolicycache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicycache_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudpolicycache + /cloudpolicycaches/{id}: + delete: + description: 删除 + operationId: cloudpolicycache_CustomizeDelete + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicycache_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudpolicycache + get: + description: 获取详情 + operationId: cloudpolicycache_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicycache_FetchCustomizeColumnsOutput' + summary: 获取公有云权限缓存详情 + tags: + - cloudpolicycache + put: + description: 更新 + operationId: cloudpolicycache_ValidateUpdateData + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicycache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudpolicycache + /cloudpolicycaches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudpolicycache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudpolicycache + post: + description: 执行操作ClassMetadata + operationId: cloudpolicycache_PerformClassMetadata + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicycache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicycache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudpolicycache + /cloudpolicycaches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudpolicycache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudpolicycache + /cloudpolicycaches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudpolicycache_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicycache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicycache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudpolicycache + /cloudpolicycaches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudpolicycache_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicycache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicycache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudpolicycache + /cloudpolicycaches/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudpolicycache_GetDetailsStatus + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudpolicycache + post: + description: 执行操作Status + operationId: cloudpolicycache_PerformStatus + parameters: + - description: The Id or Name of cloudpolicycache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicycache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudpolicycache + /cloudpolicycaches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudpolicycache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudpolicycache + /cloudpolicycaches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudpolicycache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudpolicycache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudpolicycache + /cloudpolicycaches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudpolicycache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudpolicycache + /cloudpolicycaches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudpolicycache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudpolicycache + /cloudpolicycaches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudpolicycache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudpolicycache + /cloudpolicycaches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudpolicycache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudpolicycache + /cloudpolicycaches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudpolicycache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudpolicycache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudpolicycache + /cloudroles: + get: + description: 列表 + operationId: cloudrole_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 根据权限组Id过滤资源 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + responses: + "200": + $ref: '#/responses/cloudrole_ListItemFilterOutput' + summary: 公有云角色列表 + tags: + - cloudrole + post: + description: 新建 + operationId: cloudrole_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudrole + /cloudroles/{id}: + delete: + description: 删除 + operationId: cloudrole_CustomizeDelete + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_CustomizeDeleteOutput' + summary: 删除公有云角色 + tags: + - cloudrole + get: + description: 获取详情 + operationId: cloudrole_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_FetchCustomizeColumnsOutput' + summary: 获取公有云角色详情 + tags: + - cloudrole + put: + description: 更新 + operationId: cloudrole_ValidateUpdateData + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudrole + /cloudroles/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cloudrole_PerformChangeOwner + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cloudrole + /cloudroles/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudrole_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudrole + /cloudroles/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudrole_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudrole + post: + description: 执行操作ClassMetadata + operationId: cloudrole_PerformClassMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudrole + /cloudroles/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudrole_PerformDisable + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformDisableOutput' + summary: 禁用资源 + tags: + - cloudrole + /cloudroles/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudrole_PerformEnable + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformEnableOutput' + summary: 启用资源 + tags: + - cloudrole + /cloudroles/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudrole_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudrole + /cloudroles/{id}/private: + post: + description: 执行操作Private + operationId: cloudrole_PerformPrivate + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cloudrole + /cloudroles/{id}/public: + post: + description: 执行操作Public + operationId: cloudrole_PerformPublic + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformPublicOutput' + summary: 执行操作Public + tags: + - cloudrole + /cloudroles/{id}/purge: + post: + description: 执行操作Purge + operationId: cloudrole_PerformPurge + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudrolePurgeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformPurgeOutput' + summary: 清除角色(不删除云上资源) + tags: + - cloudrole + /cloudroles/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudrole_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudrole + /cloudroles/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudrole_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudrole + /cloudroles/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudrole_GetDetailsStatus + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudrole_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudrole + post: + description: 执行操作Status + operationId: cloudrole_PerformStatus + parameters: + - description: The Id or Name of cloudrole + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudrole + /cloudroles/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudrole_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudrole + /cloudroles/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: cloudrole_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - cloudrole + /cloudroles/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: cloudrole_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - cloudrole + /cloudroles/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudrole_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudrole: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudrole_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudrole + /cloudroles/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudrole_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudrole + /cloudroles/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudrole_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudrole + /cloudroles/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudrole_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudrole + /cloudroles/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudrole_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudrole + /cloudroles/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudrole_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudrole_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudrole + /cloudusers: + get: + description: 列表 + operationId: clouduser_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 查询指定的用户（ID或名称）拥有的资源 + in: query + name: user_id + type: string + x-go-name: UserId + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - description: 过滤绑定权限的子账号 + in: query + name: cloudpolicy_id + type: string + x-go-name: CloudpolicyId + - description: 过滤属于指定权限组的子账号 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + responses: + "200": + $ref: '#/responses/clouduser_ListItemFilterOutput' + summary: 公有云用户列表 + tags: + - clouduser + post: + description: 新建 + operationId: clouduser_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_ValidateCreateDataOutput' + summary: 创建公有云用户 + tags: + - clouduser + /cloudusers/{id}: + delete: + description: 删除 + operationId: clouduser_CustomizeDelete + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_CustomizeDeleteOutput' + summary: 删除公有云用户 + tags: + - clouduser + get: + description: 获取详情 + operationId: clouduser_FetchCustomizeColumns + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_FetchCustomizeColumnsOutput' + summary: 获取公有云用户详情 + tags: + - clouduser + /cloudusers/{id}/access-keys: + get: + description: 获取指定信息AccessKeys + operationId: clouduser_GetDetailsAccessKeys + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsAccessKeysOutput' + summary: 获取指定信息AccessKeys + tags: + - clouduser + /cloudusers/{id}/attach-policy: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformAttachPolicy + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserAttachPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformAttachPolicyOutput' + summary: 绑定用户权限 + tags: + - clouduser + /cloudusers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: clouduser_PerformChangeOwner + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserChangeOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformChangeOwnerOutput' + summary: 变更子账号所属本地用户 + tags: + - clouduser + /cloudusers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: clouduser_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - clouduser + /cloudusers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: clouduser_GetDetailsClassMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - clouduser + post: + description: 执行操作ClassMetadata + operationId: clouduser_PerformClassMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - clouduser + /cloudusers/{id}/create-access-key: + post: + description: 执行操作CreateAccessKey + operationId: clouduser_PerformCreateAccessKey + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserCreateAccessKeyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformCreateAccessKeyOutput' + summary: 执行操作CreateAccessKey + tags: + - clouduser + /cloudusers/{id}/delete-access-key: + post: + description: 执行操作DeleteAccessKey + operationId: clouduser_PerformDeleteAccessKey + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDeleteAccessKeyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformDeleteAccessKeyOutput' + summary: 执行操作DeleteAccessKey + tags: + - clouduser + /cloudusers/{id}/detach-policy: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformDetachPolicy + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDetachPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformDetachPolicyOutput' + summary: 解绑用户权限 + tags: + - clouduser + /cloudusers/{id}/join-group: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformJoinGroup + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserJoinGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformJoinGroupOutput' + summary: 将用户加入权限组 + tags: + - clouduser + /cloudusers/{id}/leave-group: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformLeaveGroup + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserLeaveGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformLeaveGroupOutput' + summary: 将用户从权限组中移除 + tags: + - clouduser + /cloudusers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: clouduser_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - clouduser + /cloudusers/{id}/reset-password: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformResetPassword + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserResetPasswordInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformResetPasswordOutput' + summary: 重置用户密码 + tags: + - clouduser + /cloudusers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: clouduser_PerformSetClassMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - clouduser + /cloudusers/{id}/set-groups: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformSetGroups + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserSetGroupsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetGroupsOutput' + summary: 设置用户权限组列表(全量覆盖) + tags: + - clouduser + /cloudusers/{id}/set-policies: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformSetPolicies + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserSetPoliciesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetPoliciesOutput' + summary: 设置用户权限列表(全量覆盖) + tags: + - clouduser + /cloudusers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: clouduser_PerformSetUserMetadata + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - clouduser + /cloudusers/{id}/status: + get: + description: 获取指定信息Status + operationId: clouduser_GetDetailsStatus + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/clouduser_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - clouduser + post: + description: 执行操作Status + operationId: clouduser_PerformStatus + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformStatusOutput' + summary: 更新资源状态 + tags: + - clouduser + /cloudusers/{id}/sync: + post: + description: '用户状态必须为: available' + operationId: clouduser_PerformSync + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSyncOutput' + summary: 同步用户权限和权限组到云上 + tags: + - clouduser + /cloudusers/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: clouduser_PerformSyncstatus + parameters: + - description: The Id or Name of clouduser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformSyncstatusOutput' + summary: 同步用户状态 + tags: + - clouduser + /cloudusers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: clouduser_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - clouduser + /cloudusers/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: clouduser_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - clouduser + /cloudusers/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: clouduser_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - clouduser + /cloudusers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: clouduser_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + clouduser: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/clouduser_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - clouduser + /cloudusers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: clouduser_GetPropertySplitable + responses: + "200": + $ref: '#/responses/clouduser_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - clouduser + /cloudusers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: clouduser_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/clouduser_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - clouduser + /cloudusers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: clouduser_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - clouduser + /cloudusers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: clouduser_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/clouduser_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - clouduser + /saml_providers: + get: + description: 列表 + operationId: saml_provider_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + responses: + "200": + $ref: '#/responses/saml_provider_ListItemFilterOutput' + summary: 公有云身份提供商列表 + tags: + - saml_provider + post: + description: 新建 + operationId: saml_provider_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + saml_provider: + $ref: '#/definitions/SAMLProviderCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_ValidateCreateDataOutput' + summary: 创建云账号的身份提供商 + tags: + - saml_provider + /saml_providers/{id}: + delete: + description: 删除 + operationId: saml_provider_CustomizeDelete + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_CustomizeDeleteOutput' + summary: 删除 + tags: + - saml_provider + get: + description: 获取详情 + operationId: saml_provider_FetchCustomizeColumns + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - saml_provider + put: + description: 更新 + operationId: saml_provider_ValidateUpdateData + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_ValidateUpdateDataOutput' + summary: 更新 + tags: + - saml_provider + /saml_providers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: saml_provider_PerformChangeOwner + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - saml_provider + /saml_providers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: saml_provider_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - saml_provider + /saml_providers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: saml_provider_GetDetailsClassMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - saml_provider + post: + description: 执行操作ClassMetadata + operationId: saml_provider_PerformClassMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - saml_provider + /saml_providers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: saml_provider_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - saml_provider + /saml_providers/{id}/private: + post: + description: 执行操作Private + operationId: saml_provider_PerformPrivate + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformPrivateOutput' + summary: 执行操作Private + tags: + - saml_provider + /saml_providers/{id}/public: + post: + description: 执行操作Public + operationId: saml_provider_PerformPublic + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformPublicOutput' + summary: 执行操作Public + tags: + - saml_provider + /saml_providers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: saml_provider_PerformSetClassMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - saml_provider + /saml_providers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: saml_provider_PerformSetUserMetadata + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - saml_provider + /saml_providers/{id}/status: + get: + description: 获取指定信息Status + operationId: saml_provider_GetDetailsStatus + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/saml_provider_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - saml_provider + post: + description: 执行操作Status + operationId: saml_provider_PerformStatus + parameters: + - description: The Id or Name of saml_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformStatusOutput' + summary: 更新资源状态 + tags: + - saml_provider + /saml_providers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: saml_provider_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - saml_provider + /saml_providers/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: saml_provider_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - saml_provider + /saml_providers/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: saml_provider_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - saml_provider + /saml_providers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: saml_provider_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + saml_provider: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/saml_provider_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - saml_provider + /saml_providers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: saml_provider_GetPropertySplitable + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - saml_provider + /saml_providers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: saml_provider_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - saml_provider + /saml_providers/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: saml_provider_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - saml_provider + /saml_providers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: saml_provider_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - saml_provider + /saml_providers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: saml_provider_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/saml_provider_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - saml_provider + /samlusers: + get: + description: 列表 + operationId: samluser_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 查询指定的用户（ID或名称）拥有的资源 + in: query + name: user_id + type: string + x-go-name: UserId + - description: 根据权限组Id过滤资源 + in: query + name: cloudgroup_id + type: string + x-go-name: CloudgroupId + - description: 根据云账号名称过滤资源 + in: query + name: cloudaccount + type: string + x-go-name: Cloudaccount + - description: 根据平台过滤 + in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + responses: + "200": + $ref: '#/responses/samluser_ListItemFilterOutput' + summary: SAML认证用户列表 + tags: + - samluser + post: + description: 新建 + operationId: samluser_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + samluser: + $ref: '#/definitions/SamluserCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_ValidateCreateDataOutput' + summary: 创建SAML认证用户 + tags: + - samluser + /samlusers/{id}: + delete: + description: 删除 + operationId: samluser_CustomizeDelete + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_CustomizeDeleteOutput' + summary: 删除 + tags: + - samluser + get: + description: 获取详情 + operationId: samluser_FetchCustomizeColumns + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - samluser + put: + description: 更新 + operationId: samluser_ValidateUpdateData + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + $ref: '#/definitions/StatusDomainLevelResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_ValidateUpdateDataOutput' + summary: 更新 + tags: + - samluser + /samlusers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: samluser_PerformChangeOwner + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - samluser + /samlusers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: samluser_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - samluser + /samlusers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: samluser_GetDetailsClassMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - samluser + post: + description: 执行操作ClassMetadata + operationId: samluser_PerformClassMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - samluser + /samlusers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: samluser_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - samluser + /samlusers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: samluser_PerformSetClassMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - samluser + /samlusers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: samluser_PerformSetUserMetadata + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - samluser + /samlusers/{id}/status: + get: + description: 获取指定信息Status + operationId: samluser_GetDetailsStatus + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/samluser_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - samluser + post: + description: 执行操作Status + operationId: samluser_PerformStatus + parameters: + - description: The Id or Name of samluser + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + samluser: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformStatusOutput' + summary: 更新资源状态 + tags: + - samluser + /samlusers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: samluser_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/samluser_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - samluser + /samlusers/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: samluser_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/samluser_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - samluser + /samlusers/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: samluser_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/samluser_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - samluser + /samlusers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: samluser_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + samluser: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/samluser_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - samluser + /samlusers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: samluser_GetPropertySplitable + responses: + "200": + $ref: '#/responses/samluser_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - samluser + /samlusers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: samluser_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/samluser_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - samluser + /samlusers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: samluser_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/samluser_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - samluser + /samlusers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: samluser_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/samluser_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - samluser +produces: +- application/json +responses: + cloudgroup_CustomizeDeleteOutput: + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetails' + type: object + cloudgroup_FetchCustomizeColumnsOutput: + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetails' + type: object + cloudgroup_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + cloudgroup: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudgroup_GetDetailsClassMetadataOutput: + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudgroup_GetDetailsMetadataOutput: + schema: + properties: + cloudgroup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudgroup_GetDetailsStatusOutput: + schema: + properties: + cloudgroup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudgroup_GetPropertyDistinctFieldOutput: {} + cloudgroup_GetPropertyDomainTagValuePairsOutput: {} + cloudgroup_GetPropertyDomainTagValueTreeOutput: {} + cloudgroup_GetPropertySplitableExportOutput: {} + cloudgroup_GetPropertySplitableOutput: {} + cloudgroup_GetPropertyStatisticsOutput: + schema: + properties: + cloudgroup: + $ref: '#/definitions/StatusStatistic' + type: object + cloudgroup_GetPropertyTagValuePairsOutput: {} + cloudgroup_GetPropertyTagValueTreeOutput: {} + cloudgroup_ListItemFilterOutput: + schema: + properties: + cloudgroups: + items: + $ref: '#/definitions/CloudgroupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudgroup_PerformAddUserOutput: {} + cloudgroup_PerformAttachPolicyOutput: {} + cloudgroup_PerformChangeOwnerOutput: {} + cloudgroup_PerformClassMetadataOutput: {} + cloudgroup_PerformDetachPolicyOutput: {} + cloudgroup_PerformPrivateOutput: {} + cloudgroup_PerformPublicOutput: {} + cloudgroup_PerformPurgeSplitableOutput: {} + cloudgroup_PerformRemoveUserOutput: {} + cloudgroup_PerformSetClassMetadataOutput: {} + cloudgroup_PerformSetPoliciesOutput: {} + cloudgroup_PerformSetUserMetadataOutput: {} + cloudgroup_PerformSetUsersOutput: {} + cloudgroup_PerformStatusOutput: {} + cloudgroup_PerformSyncstatusOutput: {} + cloudgroup_ValidateCreateDataOutput: + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetails' + type: object + cloudgroup_ValidateUpdateDataOutput: + schema: + properties: + cloudgroup: + $ref: '#/definitions/CloudgroupDetails' + type: object + cloudgroupcache_CustomizeDeleteOutput: + schema: + properties: + cloudgroupcache: + $ref: '#/definitions/CloudgroupcacheDetails' + type: object + cloudgroupcache_FetchCustomizeColumnsOutput: + schema: + properties: + cloudgroupcache: + $ref: '#/definitions/CloudgroupcacheDetails' + type: object + cloudgroupcache_GetDetailsClassMetadataOutput: + schema: + properties: + cloudgroupcache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudgroupcache_GetDetailsMetadataOutput: + schema: + properties: + cloudgroupcache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudgroupcache_GetDetailsStatusOutput: + schema: + properties: + cloudgroupcache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudgroupcache_GetPropertyDistinctFieldOutput: {} + cloudgroupcache_GetPropertySplitableExportOutput: {} + cloudgroupcache_GetPropertySplitableOutput: {} + cloudgroupcache_GetPropertyStatisticsOutput: + schema: + properties: + cloudgroupcache: + $ref: '#/definitions/StatusStatistic' + type: object + cloudgroupcache_GetPropertyTagValuePairsOutput: {} + cloudgroupcache_GetPropertyTagValueTreeOutput: {} + cloudgroupcache_ListItemFilterOutput: + schema: + properties: + cloudgroupcaches: + items: + $ref: '#/definitions/CloudgroupcacheDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudgroupcache_PerformClassMetadataOutput: {} + cloudgroupcache_PerformPurgeSplitableOutput: {} + cloudgroupcache_PerformSetClassMetadataOutput: {} + cloudgroupcache_PerformSetUserMetadataOutput: {} + cloudgroupcache_PerformStatusOutput: {} + cloudgroupcache_PerformSyncstatusOutput: {} + cloudpolicy_CustomizeDeleteOutput: + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyDetails' + type: object + cloudpolicy_FetchCustomizeColumnsOutput: + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyDetails' + type: object + cloudpolicy_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + cloudpolicy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudpolicy_GetDetailsClassMetadataOutput: + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudpolicy_GetDetailsMetadataOutput: + schema: + properties: + cloudpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudpolicy_GetDetailsStatusOutput: + schema: + properties: + cloudpolicy: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudpolicy_GetPropertyDistinctFieldOutput: {} + cloudpolicy_GetPropertyDomainTagValuePairsOutput: {} + cloudpolicy_GetPropertyDomainTagValueTreeOutput: {} + cloudpolicy_GetPropertySplitableExportOutput: {} + cloudpolicy_GetPropertySplitableOutput: {} + cloudpolicy_GetPropertyStatisticsOutput: + schema: + properties: + cloudpolicy: + $ref: '#/definitions/StatusStatistic' + type: object + cloudpolicy_GetPropertyTagValuePairsOutput: {} + cloudpolicy_GetPropertyTagValueTreeOutput: {} + cloudpolicy_ListItemFilterOutput: + schema: + properties: + cloudpolicies: + items: + $ref: '#/definitions/CloudpolicyDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudpolicy_PerformAssignGroupOutput: {} + cloudpolicy_PerformCacheOutput: {} + cloudpolicy_PerformChangeOwnerOutput: {} + cloudpolicy_PerformClassMetadataOutput: {} + cloudpolicy_PerformLockOutput: {} + cloudpolicy_PerformPrivateOutput: {} + cloudpolicy_PerformPublicOutput: {} + cloudpolicy_PerformPurgeSplitableOutput: {} + cloudpolicy_PerformRevokeGroupOutput: {} + cloudpolicy_PerformSetClassMetadataOutput: {} + cloudpolicy_PerformSetUserMetadataOutput: {} + cloudpolicy_PerformStatusOutput: {} + cloudpolicy_PerformSyncstatusOutput: {} + cloudpolicy_PerformUnlockOutput: {} + cloudpolicy_ValidateCreateDataOutput: + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyDetails' + type: object + cloudpolicy_ValidateUpdateDataOutput: + schema: + properties: + cloudpolicy: + $ref: '#/definitions/CloudpolicyDetails' + type: object + cloudpolicycache_CustomizeDeleteOutput: + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/CloudpolicycacheDetails' + type: object + cloudpolicycache_FetchCustomizeColumnsOutput: + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/CloudpolicycacheDetails' + type: object + cloudpolicycache_GetDetailsClassMetadataOutput: + schema: + properties: + cloudpolicycache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudpolicycache_GetDetailsMetadataOutput: + schema: + properties: + cloudpolicycache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudpolicycache_GetDetailsStatusOutput: + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudpolicycache_GetPropertyDistinctFieldOutput: {} + cloudpolicycache_GetPropertySplitableExportOutput: {} + cloudpolicycache_GetPropertySplitableOutput: {} + cloudpolicycache_GetPropertyStatisticsOutput: + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/StatusStatistic' + type: object + cloudpolicycache_GetPropertyTagValuePairsOutput: {} + cloudpolicycache_GetPropertyTagValueTreeOutput: {} + cloudpolicycache_ListItemFilterOutput: + schema: + properties: + cloudpolicycaches: + items: + $ref: '#/definitions/CloudpolicycacheDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudpolicycache_PerformClassMetadataOutput: {} + cloudpolicycache_PerformPurgeSplitableOutput: {} + cloudpolicycache_PerformSetClassMetadataOutput: {} + cloudpolicycache_PerformSetUserMetadataOutput: {} + cloudpolicycache_PerformStatusOutput: {} + cloudpolicycache_ValidateCreateDataOutput: + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/CloudpolicycacheDetails' + type: object + cloudpolicycache_ValidateUpdateDataOutput: + schema: + properties: + cloudpolicycache: + $ref: '#/definitions/CloudpolicycacheDetails' + type: object + cloudrole_CustomizeDeleteOutput: + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudroleDetails' + type: object + cloudrole_FetchCustomizeColumnsOutput: + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudroleDetails' + type: object + cloudrole_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + cloudrole: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudrole_GetDetailsClassMetadataOutput: + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudrole_GetDetailsMetadataOutput: + schema: + properties: + cloudrole: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudrole_GetDetailsStatusOutput: + schema: + properties: + cloudrole: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudrole_GetPropertyDistinctFieldOutput: {} + cloudrole_GetPropertyDomainTagValuePairsOutput: {} + cloudrole_GetPropertyDomainTagValueTreeOutput: {} + cloudrole_GetPropertySplitableExportOutput: {} + cloudrole_GetPropertySplitableOutput: {} + cloudrole_GetPropertyStatisticsOutput: + schema: + properties: + cloudrole: + $ref: '#/definitions/StatusStatistic' + type: object + cloudrole_GetPropertyTagValuePairsOutput: {} + cloudrole_GetPropertyTagValueTreeOutput: {} + cloudrole_ListItemFilterOutput: + schema: + properties: + cloudroles: + items: + $ref: '#/definitions/CloudroleDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudrole_PerformChangeOwnerOutput: {} + cloudrole_PerformClassMetadataOutput: {} + cloudrole_PerformDisableOutput: {} + cloudrole_PerformEnableOutput: {} + cloudrole_PerformPrivateOutput: {} + cloudrole_PerformPublicOutput: {} + cloudrole_PerformPurgeOutput: {} + cloudrole_PerformPurgeSplitableOutput: {} + cloudrole_PerformSetClassMetadataOutput: {} + cloudrole_PerformSetUserMetadataOutput: {} + cloudrole_PerformStatusOutput: {} + cloudrole_ValidateCreateDataOutput: + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudroleDetails' + type: object + cloudrole_ValidateUpdateDataOutput: + schema: + properties: + cloudrole: + $ref: '#/definitions/CloudroleDetails' + type: object + clouduser_CustomizeDeleteOutput: + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDetails' + type: object + clouduser_FetchCustomizeColumnsOutput: + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDetails' + type: object + clouduser_GetDetailsAccessKeysOutput: {} + clouduser_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + clouduser: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + clouduser_GetDetailsClassMetadataOutput: + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + clouduser_GetDetailsMetadataOutput: + schema: + properties: + clouduser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + clouduser_GetDetailsStatusOutput: + schema: + properties: + clouduser: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + clouduser_GetPropertyDistinctFieldOutput: {} + clouduser_GetPropertyDomainTagValuePairsOutput: {} + clouduser_GetPropertyDomainTagValueTreeOutput: {} + clouduser_GetPropertySplitableExportOutput: {} + clouduser_GetPropertySplitableOutput: {} + clouduser_GetPropertyTagValuePairsOutput: {} + clouduser_GetPropertyTagValueTreeOutput: {} + clouduser_ListItemFilterOutput: + schema: + properties: + cloudusers: + items: + $ref: '#/definitions/ClouduserDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + clouduser_PerformAttachPolicyOutput: {} + clouduser_PerformChangeOwnerOutput: {} + clouduser_PerformClassMetadataOutput: {} + clouduser_PerformCreateAccessKeyOutput: {} + clouduser_PerformDeleteAccessKeyOutput: {} + clouduser_PerformDetachPolicyOutput: {} + clouduser_PerformJoinGroupOutput: {} + clouduser_PerformLeaveGroupOutput: {} + clouduser_PerformPurgeSplitableOutput: {} + clouduser_PerformResetPasswordOutput: {} + clouduser_PerformSetClassMetadataOutput: {} + clouduser_PerformSetGroupsOutput: {} + clouduser_PerformSetPoliciesOutput: {} + clouduser_PerformSetUserMetadataOutput: {} + clouduser_PerformStatusOutput: {} + clouduser_PerformSyncOutput: {} + clouduser_PerformSyncstatusOutput: {} + clouduser_ValidateCreateDataOutput: + schema: + properties: + clouduser: + $ref: '#/definitions/ClouduserDetails' + type: object + saml_provider_CustomizeDeleteOutput: + schema: + properties: + saml_provider: + $ref: '#/definitions/SAMLProviderDetails' + type: object + saml_provider_FetchCustomizeColumnsOutput: + schema: + properties: + saml_provider: + $ref: '#/definitions/SAMLProviderDetails' + type: object + saml_provider_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + saml_provider: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + saml_provider_GetDetailsClassMetadataOutput: + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + saml_provider_GetDetailsMetadataOutput: + schema: + properties: + saml_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + saml_provider_GetDetailsStatusOutput: + schema: + properties: + saml_provider: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + saml_provider_GetPropertyDistinctFieldOutput: {} + saml_provider_GetPropertyDomainTagValuePairsOutput: {} + saml_provider_GetPropertyDomainTagValueTreeOutput: {} + saml_provider_GetPropertySplitableExportOutput: {} + saml_provider_GetPropertySplitableOutput: {} + saml_provider_GetPropertyStatisticsOutput: + schema: + properties: + saml_provider: + $ref: '#/definitions/StatusStatistic' + type: object + saml_provider_GetPropertyTagValuePairsOutput: {} + saml_provider_GetPropertyTagValueTreeOutput: {} + saml_provider_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + saml_providers: + items: + $ref: '#/definitions/SAMLProviderDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + saml_provider_PerformChangeOwnerOutput: {} + saml_provider_PerformClassMetadataOutput: {} + saml_provider_PerformPrivateOutput: {} + saml_provider_PerformPublicOutput: {} + saml_provider_PerformPurgeSplitableOutput: {} + saml_provider_PerformSetClassMetadataOutput: {} + saml_provider_PerformSetUserMetadataOutput: {} + saml_provider_PerformStatusOutput: {} + saml_provider_ValidateCreateDataOutput: + schema: + properties: + saml_provider: + $ref: '#/definitions/SAMLProviderDetails' + type: object + saml_provider_ValidateUpdateDataOutput: + schema: + properties: + saml_provider: + $ref: '#/definitions/SAMLProviderDetails' + type: object + samluser_CustomizeDeleteOutput: + schema: + properties: + samluser: + $ref: '#/definitions/SamluserDetails' + type: object + samluser_FetchCustomizeColumnsOutput: + schema: + properties: + samluser: + $ref: '#/definitions/SamluserDetails' + type: object + samluser_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + samluser: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + samluser_GetDetailsClassMetadataOutput: + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + samluser_GetDetailsMetadataOutput: + schema: + properties: + samluser: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + samluser_GetDetailsStatusOutput: + schema: + properties: + samluser: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + samluser_GetPropertyDistinctFieldOutput: {} + samluser_GetPropertyDomainTagValuePairsOutput: {} + samluser_GetPropertyDomainTagValueTreeOutput: {} + samluser_GetPropertySplitableExportOutput: {} + samluser_GetPropertySplitableOutput: {} + samluser_GetPropertyTagValuePairsOutput: {} + samluser_GetPropertyTagValueTreeOutput: {} + samluser_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + samlusers: + items: + $ref: '#/definitions/SamluserDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + samluser_PerformChangeOwnerOutput: {} + samluser_PerformClassMetadataOutput: {} + samluser_PerformPurgeSplitableOutput: {} + samluser_PerformSetClassMetadataOutput: {} + samluser_PerformSetUserMetadataOutput: {} + samluser_PerformStatusOutput: {} + samluser_ValidateCreateDataOutput: + schema: + properties: + samluser: + $ref: '#/definitions/SamluserDetails' + type: object + samluser_ValidateUpdateDataOutput: + schema: + properties: + samluser: + $ref: '#/definitions/SamluserDetails' + type: object +schemes: +- https +- http +securityDefinitions: + keystone: + in: header + name: X-Auth-Token + type: apiKey +swagger: "2.0" diff --git a/docs/swagger/swagger_compute.yaml b/docs/swagger/swagger_compute.yaml new file mode 100644 index 0000000000..597b4509c2 --- /dev/null +++ b/docs/swagger/swagger_compute.yaml @@ -0,0 +1,165449 @@ +basePath: / +consumes: +- application/json +definitions: + AccessGroupCacheDetails: + properties: + access_group: + description: 权限组名称 + type: string + x-go-name: AccessGroup + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AccessGroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AccessGroupDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AccessGroupRuleCreateInput: + properties: + AccessGroupId: + type: string + Description: + type: string + Priority: + format: int64 + type: integer + RWAccessType: + type: string + Source: + type: string + UserAccessType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AccessGroupRuleDetails: + properties: + access_group: + description: 权限组名称 + type: string + x-go-name: AccessGroup + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AccessGroupRuleUpdateInput: + properties: + Description: + type: string + Priority: + format: int64 + type: integer + RWAccessType: + type: string + Source: + type: string + UserAccessType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AppDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AppEnvironmentDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AttachNetworkInput: + properties: + nets: + description: 添加的网卡的配置 + items: + $ref: '#/definitions/NetworkConfig' + type: array + x-go-name: Nets + required: + - nets + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + AutoRenewInput: + properties: + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + BackupStorageCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + capacity_mb: + description: 'description: Capacity size in MB' + format: int64 + type: integer + x-go-name: CapacityMb + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + nfs_host: + description: 'description: host of nfs, storage_type 为 nfs 时, 此参数必传' + example: 192.168.222.2 + type: string + x-go-name: NfsHost + nfs_shared_dir: + description: 'description: shared dir of nfs, storage_type 为 nfs 时, 此参数必传' + example: /nfs_root/ + type: string + x-go-name: NfsSharedDir + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_type: + description: 'description: storage type' + enum: + - nfs + type: string + x-go-name: StorageType + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BackupStorageDetails: + properties: + NfsHost: + type: string + NfsSharedDir: + type: string + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BaremetalDiskConfig: + properties: + adapter: + format: int64 + type: integer + x-go-name: Adapter + cachedbadbbu: + type: boolean + x-go-name: Cachedbadbbu + conf: + description: raid config + type: string + x-go-name: Conf + count: + format: int64 + type: integer + x-go-name: Count + direct: + type: boolean + x-go-name: Direct + driver: + type: string + x-go-name: Driver + ra: + type: boolean + x-go-name: RA + range: + items: + format: int64 + type: integer + type: array + x-go-name: Range + size: + items: + format: int64 + type: integer + type: array + x-go-name: Size + splits: + type: string + x-go-name: Splits + strip: + format: int64 + type: integer + x-go-name: Strip + type: + description: |- + Index int `json:"index"` + disk type + type: string + x-go-name: Type + wt: + type: boolean + x-go-name: WT + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BaremetalagentCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + access_ip: + type: string + x-go-name: AccessIp + agent_type: + type: string + x-go-name: AgentType + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + manager_uri: + type: string + x-go-name: ManagerUri + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + version: + type: string + x-go-name: Version + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BaremetalagentDetails: + properties: + access_ip: + type: string + x-go-name: AccessIp + agent_type: + type: string + x-go-name: AgentType + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_image_cache: + type: boolean + x-go-name: DisableImageCache + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager_uri: + type: string + x-go-name: ManagerUri + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + status: + type: string + x-go-name: Status + storagecache_id: + type: string + x-go-name: StoragecacheId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + version: + type: string + x-go-name: Version + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BaremetalagentUpdateInput: + properties: + access_ip: + type: string + x-go-name: AccessIp + agent_type: + type: string + x-go-name: AgentType + description: + description: 资源描述 + type: string + x-go-name: Description + manager_uri: + type: string + x-go-name: ManagerUri + name: + description: 资源名称 + type: string + x-go-name: Name + version: + type: string + x-go-name: Version + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketAclInput: + properties: + Acl: + $ref: '#/definitions/TBucketACLType' + Key: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketCORSRule: + properties: + AllowedHeaders: + items: + type: string + type: array + AllowedMethods: + items: + type: string + type: array + AllowedOrigins: + description: 允许的源站，可以是* + items: + type: string + type: array + ExposeHeaders: + items: + type: string + type: array + Id: + description: 规则区别标识 + type: string + MaxAgeSeconds: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketCORSRuleDeleteInput: + properties: + Id: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketCORSRules: + properties: + data: + items: + $ref: '#/definitions/BucketCORSRule' + type: array + x-go-name: Data + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_class: + type: string + x-go-name: StorageClass + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketDetails: + properties: + access_urls: + description: 访问URL列表 + items: + $ref: '#/definitions/SBucketAccessUrl' + type: array + x-go-name: AccessUrls + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + acl: + type: string + x-go-name: Acl + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + location: + type: string + x-go-name: Location + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + object_cnt: + format: int64 + type: integer + x-go-name: ObjectCnt + object_cnt_limit: + format: int64 + type: integer + x-go-name: ObjectCntLimit + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + size_bytes: + format: int64 + type: integer + x-go-name: SizeBytes + size_bytes_limit: + format: int64 + type: integer + x-go-name: SizeBytesLimit + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_class: + type: string + x-go-name: StorageClass + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketGetAclOutput: + properties: + acl: + description: ACL + type: string + x-go-name: Acl + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketGetObjectsOutput: + properties: + data: + description: 对象列表 + items: + $ref: '#/definitions/SCloudObject' + type: array + x-go-name: Data + marker_field: + description: 排序字段，总是key + example: key + type: string + x-go-name: MarkerField + marker_order: + description: 排序顺序，总是降序 + example: DESC + type: string + x-go-name: MarkerOrder + next_marker: + description: 下一页请求的paging_marker标识 + type: string + x-go-name: NextMarker + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketMetadataInput: + properties: + Key: + items: + type: string + type: array + Metadata: + $ref: '#/definitions/Header' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPerformDeleteInput: + properties: + keys: + description: 待删除对象KEY + items: + type: string + type: array + x-go-name: Keys + required: + - keys + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPerformMakedirInput: + properties: + key: + description: 目录对象KEY + type: string + x-go-name: Key + required: + - key + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPerformTempUrlInput: + properties: + expire_seconds: + description: 过期时间，单位秒 + format: int64 + type: integer + x-go-name: ExpireSeconds + key: + description: 对象KEY + type: string + x-go-name: Key + method: + description: 访问对象方法 + type: string + x-go-name: Method + required: + - key + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPerformTempUrlOutput: + properties: + url: + description: 生成的临时URL + type: string + x-go-name: Url + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPolicy: + properties: + Data: + items: + $ref: '#/definitions/BucketPolicyStatement' + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPolicyDeleteInput: + properties: + Id: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPolicyStatement: + properties: + Action: + description: 授权的行为 + items: + type: string + type: array + CannedAction: + description: Read|ReadWrite|FullControl + type: string + Condition: + additionalProperties: + additionalProperties: + type: object + type: object + description: 触发授权的条件 + type: object + Effect: + description: Allow|Deny + type: string + Id: + description: 根据index 生成 + type: string + Principal: + additionalProperties: + items: + type: string + type: array + description: 授权的目标主体 + type: object + PrincipalId: + description: 解析字段，主账号id:子账号id + items: + type: string + type: array + PrincipalNames: + additionalProperties: + type: string + description: map[主账号id:子账号id]子账号name + type: object + Resource: + description: 被授权的资源地址 + items: + type: string + type: array + ResourcePath: + description: 资源路径 + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketPolicyStatementInput: + properties: + CannedAction: + description: Read|ReadWrite|FullControl + type: string + Effect: + description: Allow|Deny + type: string + IpEquals: + description: ip 条件 + items: + type: string + type: array + IpNotEquals: + items: + type: string + type: array + PrincipalId: + description: 主账号id:子账号id + items: + type: string + type: array + ResourcePath: + description: 被授权的资源地址,/* + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketRefererConf: + properties: + AllowEmptyRefer: + description: 是否允许空referer 访问 + type: boolean + DomainList: + description: 域名列表 + items: + type: string + type: array + RefererType: + description: |- + Referer Type + enmu: Black-List, White-List + type: string + enabled: + description: 是否开启 + type: boolean + x-go-name: Enabled + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketWebsiteConf: + properties: + ErrorDocument: + description: 错误时返回的文档 + type: string + Index: + description: 主页 + type: string + Protocol: + description: http或https + type: string + Rules: + items: + $ref: '#/definitions/BucketWebsiteRoutingRule' + type: array + Url: + description: 访问网站url + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + BucketWebsiteRoutingRule: + properties: + ConditionErrorCode: + type: string + ConditionPrefix: + type: string + RedirectProtocol: + type: string + RedirectReplaceKey: + type: string + RedirectReplaceKeyPrefix: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAGuestNet: + properties: + ip_nets: + items: + $ref: '#/definitions/CAIPNet' + type: array + x-go-name: IPNets + name: + description: 'description: Host 的 Name' + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAHostNet: + properties: + ip: + description: 'description: IP' + type: string + x-go-name: IP + name: + description: 'description: Host 的 Name' + type: string + x-go-name: Name + suitable_network: + description: 'description: 合适的已有网络' + type: string + x-go-name: SuitableNetwork + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAIPNet: + properties: + ip: + description: 'description: IP' + type: string + x-go-name: IP + suitable_network: + description: 'description: 合适的已有网络' + type: string + x-go-name: SuitableNetwork + vlan_id: + format: int32 + type: integer + x-go-name: VlanID + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CANetConf: + properties: + description: + type: string + x-go-name: Description + guest_gateway: + type: string + x-go-name: GuestGateway + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + format: int8 + type: integer + x-go-name: GuestIpMask + guest_ip_start: + type: string + x-go-name: GuestIpStart + name: + type: string + x-go-name: Name + vlan_id: + format: int32 + type: integer + x-go-name: VlanID + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAPWire: + properties: + distributed: + type: boolean + x-go-name: Distributed + guest_networks: + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: GuestNetworks + host_networks: + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: HostNetworks + hosts: + items: + $ref: '#/definitions/SimpleHost' + type: array + x-go-name: Hosts + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAWireConf: + properties: + description: + description: 'description: wire description' + type: string + x-go-name: Description + name: + description: 'description: wire name' + type: string + x-go-name: Name + zone_ids: + description: Zoneids to be selected + items: + type: string + type: array + x-go-name: ZoneIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CAWireNet: + properties: + host_suggested_networks: + description: 'description: 没有合适的已有网络，推荐的网络配置' + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: HostSuggestedNetworks + hosts: + items: + $ref: '#/definitions/CAHostNet' + type: array + x-go-name: Hosts + suggested_wire: + $ref: '#/definitions/CAWireConf' + suitable_wire: + type: string + x-go-name: SuitableWire + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CDNDomainCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Origins: + $ref: '#/definitions/SCdnOrigins' + area: + description: |- + 加速区域 + enmu: mainland, overseas, global + requrired: true + type: string + x-go-name: Area + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + service_type: + description: 服务类型 + type: string + x-go-name: ServiceType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - Origins + - service_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CDNDomainDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CacheImageInput: + properties: + checksum: + description: 'swagger: ignore' + type: string + x-go-name: Checksum + format: + type: string + x-go-name: Format + image: + type: string + x-go-name: Image + image_id: + type: string + x-go-name: ImageId + image_name: + description: 'swagger: ignore' + type: string + x-go-name: ImageName + is_force: + type: boolean + x-go-name: IsForce + os_arch: + description: 'swagger: ignore' + type: string + x-go-name: OsArch + os_distribution: + description: 'swagger: ignore' + type: string + x-go-name: OsDistribution + os_full_version: + description: 'swagger: ignore' + type: string + x-go-name: OsFullVersion + os_type: + description: 'swagger: ignore' + type: string + x-go-name: OsType + os_version: + description: 'swagger: ignore' + type: string + x-go-name: OsVersion + parent_task_id: + description: 'swagger: ignore' + type: string + x-go-name: ParentTaskId + server_id: + description: 'swagger: ignore' + type: string + x-go-name: ServerId + source_host_id: + description: 'swagger: ignore' + type: string + x-go-name: SourceHostId + src_url: + description: 'swagger: ignore' + type: string + x-go-name: SrcUrl + storagecache_id: + description: 'swagger: ignore' + type: string + x-go-name: StoragecacheId + zone: + description: 'swagger: ignore' + type: string + x-go-name: Zone + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CachedImageManagerCacheImageInput: + properties: + image_id: + type: string + x-go-name: ImageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CachedImageUncacheImageInput: + properties: + is_force: + default: false + description: 是否强制清除缓存 + type: boolean + x-go-name: IsForce + storagecache_id: + description: 存储缓存名Id + type: string + x-go-name: StoragecacheId + required: + - storagecache_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CachedimageDetails: + properties: + cached_count: + description: 此镜像被使用次数 + example: 0 + format: int64 + type: integer + x-go-name: CachedCount + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + hypervisor: + description: 虚拟化类型 + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + image_type: + description: '镜像类型, system: 公有云镜像, customized: 自定义镜像' + example: system + type: string + x-go-name: ImageType + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + info: + description: 镜像详情信息 + example: + deleted: false + disk_format: qcow2 + id: img-a6uucnfl + is_public: true + min_disk: 51200 + min_ram: 0 + name: FreeBSD 11.1 64bit + properties: + os_arch: x86_64 + os_distribution: FreeBSD + os_type: FreeBSD + os_version: "11" + protected: true + size: 53687091200 + status: active + type: object + x-go-name: Info + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + last_ref: + description: |- + 最近一次缓存引用时间 + 2020-01-17T05:20:54.000000Z + format: date-time + type: string + x-go-name: LastRef + last_sync: + description: 上此同步时间 + example: "2020-01-17T05:28:54.000000Z" + format: date-time + type: string + x-go-name: LastSync + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + os_distribution: + description: 操作系统发行版 + example: FreeBSD + type: string + x-go-name: OsDistribution + os_type: + description: 操作系统类型 + example: FreeBSD + type: string + x-go-name: OsType + os_version: + description: 操作系统版本 + example: "11" + type: string + x-go-name: OsVersion + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + ref_count: + description: 引用次数 + example: 0 + format: int64 + type: integer + x-go-name: RefCount + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + size: + description: '镜像大小单位: Byte' + example: 53687091200 + format: int64 + type: integer + x-go-name: Size + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 镜像状态, 和info里面的status一致 + example: active + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + uefi: + description: 是否支持UEFI + example: false + type: boolean + x-go-name: UEFI + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CdnDomain: + properties: + Area: + description: 区域 mainland|overseas|global + type: string + Cname: + description: cdn Cname + type: string + Domain: + description: cdn加速域名 + type: string + Origin: + description: 源站 + type: string + OriginType: + description: 源站类型 domain|ip|bucket + type: string + Status: + description: 状态 rejected(域名未审核)|processing(部署中)|online|offline + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CdnDomains: + properties: + data: + items: + $ref: '#/definitions/CdnDomain' + type: array + x-go-name: Data + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + Cdrom: + properties: + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + detail: + type: string + x-go-name: Detail + ordinal: + format: int64 + type: integer + x-go-name: Ordinal + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + CloudaccountCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + As: + description: 弹性伸缩服务 + type: string + Bms: + description: 裸金属服务器 + type: string + Bss: + description: 合作伙伴运营能力 + type: string + Cce: + description: 云容器服务 + type: string + Cci: + description: 云容器实例 CCI + type: string + Ces: + description: 监控服务 CloudEye + type: string + Csbs: + description: 云服务器备份服务 + type: string + Cts: + description: 云审计服务 + type: string + Dcs: + description: 分布式缓存服务 + type: string + DefaultRegion: + description: 默认区域Id, Apara及HCSO需要此参数 + example: cn-north-2 + type: string + DefaultSubnetDns: + description: 默认DNS + example: 10.125.0.26,10.125.0.27 + type: string + Ecs: + description: 弹性云服务 + type: string + Elb: + description: 弹性负载均衡 ELB + type: string + EndpointDomain: + description: 华为私有云Endpoint域名 + example: hcso.com.cn + type: string + Eps: + description: 企业项目 + type: string + Evs: + description: 云硬盘 EVS + type: string + Iam: + description: 统一身份认证服务 + type: string + Ims: + description: 镜像服务 + type: string + Modelarts: + description: Modelarts + type: string + Nat: + description: Nat网关 NAT + type: string + Obs: + description: 对象存储服务 OBS + type: string + Rds: + description: 关系型数据库 RDS + type: string + SfsTurbo: + description: 文件系统 + type: string + SkipDuplicateAccountCheck: + description: 跳过重复账号注册检查 + type: boolean + Vbs: + description: 云硬盘备份 VBS + type: string + Vpc: + description: 虚拟私有云 VPC + type: string + access_key_id: + description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeyId + access_key_secret: + description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeySecret + access_url: + description: 认证地址 + type: string + x-go-name: AccessUrl + account: + description: |- + 账号信息，各个平台字段不尽相同，以下是各个平台账号创建所需要的字段 + + + + 云平台 |字段 | 翻译 | 是否必传 | 默认值 | 可否更新 | 获取方式 | + ------ |------ | ------ | --------- | -------- |-------- |-------- | + Aliyun |access_key_id |秘钥ID | 是 | | 是 | | + Aliyun |access_key_secret |秘钥Key | 是 | | 是 | | + Qcloud |app_id |APP ID | 是 | | 否 | | + Qcloud |secret_id |秘钥ID | 是 | | 是 | | + Qcloud |secret_key |秘钥Key | 是 | | 是 | | + OpenStack |project_name |用户所在项目 | 是 | | 是 | | + OpenStack |username |用户名 | 是 | | 是 | | + OpenStack |password |用户密码 | 是 | | 是 | | + OpenStack |auth_url |认证地址 | 是 | | 否 | | + OpenStack |domain_name |用户所在的域 | 否 |Default | 是 | | + VMware |username |用户名 | 是 | | 是 | | + VMware |password |密码 | 是 | | 是 | | + VMware |host |主机IP或域名 | 是 | | 否 | | + VMware |port |主机端口 | 否 |443 | 否 | | + Azure |directory_id |目录ID | 是 | | 否 | | + Azure |environment |区域 | 是 | | 否 | | + Azure |client_id |客户端ID | 是 | | 是 | | + Azure |client_secret |客户端密码 | 是 | | 是 | | + Huawei |access_key_id |秘钥ID | 是 | | 是 | | + Huawei |access_key_secret |秘钥 | 是 | | 是 | | + Huawei |environment |区域 | 是 | | 否 | | + Aws |access_key_id |秘钥ID | 是 | | 是 | | + Aws |access_key_secret |秘钥 | 是 | | 是 | | + Aws |environment |区域 | 是 | | 否 | | + Ucloud |access_key_id |秘钥ID | 是 | | 是 | | + Ucloud |access_key_secret |秘钥 | 是 | | 是 | | + Google |project_id |项目ID | 是 | | 否 | | + Google |client_email |客户端email | 是 | | 否 | | + Google |private_key_id |秘钥ID | 是 | | 是 | | + Google |private_key |秘钥Key | 是 | | 是 | | + type: string + x-go-name: Account + app_id: + description: app id (Qcloud) + type: string + x-go-name: AppId + auto_create_project: + default: false + description: 自动根据云上项目或订阅创建本地项目, OpenStack此参数为true + type: boolean + x-go-name: AutoCreateProject + auto_url: + description: 认证地址 (openstack,zstack) + type: string + x-go-name: AuthUrl + brand: + description: |- + 指定云平台品牌, 此参数默认和provider相同 + requried: false + + + + provider | 支持的参数 | + -------- | ---------- | + VMware | VMware | + Aliyun | Aliyun | + Qcloud | Qcloud | + Azure | Azure | + Aws | Aws | + Huawei | Huawei | + OpenStack | OpenStack | + Ucloud | Ucloud | + ZStack | ZStack, DStack | + Google | Google | + Ctyun | Ctyun | + type: string + x-go-name: Brand + client_id: + description: 客户端ID (Azure) + type: string + x-go-name: ClientId + client_secret: + description: 客户端秘钥 (Azure) + type: string + x-go-name: ClientSecret + crm_biz_id: + description: customInfo type=1 + type: string + x-go-name: CrmBizId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + directory_id: + description: 目录ID (Azure) + type: string + x-go-name: DirectoryId + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + domain_name: + default: Default + description: 账号所在的域 (openstack) + type: string + x-go-name: DomainName + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + endpoint: + description: 端点 (s3) 或 Apsara(飞天) + type: string + x-go-name: Endpoint + environment: + description: 环境 (Azure, Aws, huawei, ctyun, aliyun) + type: string + x-go-name: Environment + gcp_client_email: + description: Google服务账号email (gcp) + type: string + x-go-name: GCPClientEmail + gcp_private_key: + description: Google服务账号秘钥 (gcp) + type: string + x-go-name: GCPPrivateKey + gcp_private_key_id: + description: Google服务账号秘钥id (gcp) + type: string + x-go-name: GCPPrivateKeyId + gcp_project_id: + description: Google服务账号project id (gcp) + type: string + x-go-name: GCPProjectId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + host: + description: 主机IP (esxi) + type: string + x-go-name: Host + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + options: + description: 额外信息,例如账单的access key + type: object + x-go-name: Options + organization_id: + description: 飞天允许的最高组织id, 默认为1 + format: int64 + type: integer + x-go-name: OrganizationId + password: + description: 密码 (openstack, zstack, esxi) + type: string + x-go-name: Password + port: + description: 主机端口 (esxi) + format: int64 + type: integer + x-go-name: Port + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_mapping_id: + type: string + x-go-name: ProjectMappingId + project_name: + description: 账号所在的项目 (openstack) + type: string + x-go-name: ProjectName + provider: + description: |- + 指定云平台 + Qcloud: 腾讯云 + Ctyun: 天翼云 + enum: + - VMware + - ' Aliyun' + - ' Qcloud' + - ' Azure' + - ' Aws' + - ' Huawei' + - ' OpenStack' + - ' Ucloud' + - ' ZStack' + - ' Google' + - ' Ctyun' + - ' JDcloud' + type: string + x-go-name: Provider + proxy_setting_id: + description: 代理配置 + type: string + x-go-name: ProxySettingId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + read_only: + type: boolean + x-go-name: ReadOnly + saml_auth: + default: false + description: 是否启用SAML认证 + type: boolean + x-go-name: SAMLAuth + secret_id: + description: 秘钥ID (Qcloud) + type: string + x-go-name: SecretId + secret_key: + description: 秘钥key (Qcloud) + type: string + x-go-name: SecretKey + show_sub_accounts: + description: 仅当show_sub_accounts=true并且dry_run=true时才返回sub accounts 信息, 且不会创建云账号 + type: boolean + x-go-name: ShowSubAccounts + start_sync: + description: 是否立即开始同步资源 + type: boolean + x-go-name: StartSync + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + username: + description: 用户名 (openstack, zstack, esxi) + type: string + x-go-name: Username + zone: + description: VMware 账号有zone属性 + type: string + x-go-name: Zone + required: + - name + - EndpointDomain + - DefaultRegion + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountDetail: + properties: + LastSyncCost: + description: 上次同步耗时 + type: string + ProjectMapping: + type: string + access_url: + description: 云环境连接地址 + type: string + x-go-name: AccessUrl + account: + description: 云账号 + type: string + x-go-name: Account + account_id: + description: 云环境唯一标识 + type: string + x-go-name: AccountId + auto_create_project: + description: 是否根据云上项目自动在本地创建对应项目 + example: false + type: boolean + x-go-name: AutoCreateProject + balance: + description: 账户余额 + example: 124.2 + format: double + type: number + x-go-name: Balance + brand: + description: 品牌信息, 一般和provider相同 + example: DStack + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: |- + 云账号环境类型 + public: 公有云 + private: 私有云 + onpremise: 本地IDC + example: public + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disk_count: + description: 云盘数量 + example: 12 + format: int64 + type: integer + x-go-name: DiskCount + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + eip_count: + description: 弹性公网Ip数量 + example: 2 + format: int64 + type: integer + x-go-name: EipCount + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + error_count: + description: 账号探测异常错误次数 + format: int64 + type: integer + x-go-name: ErrorCount + guest_count: + description: 云主机数量 + example: 4 + format: int64 + type: integer + x-go-name: GuestCount + health_status: + description: 账号健康状态 + example: normal + type: string + x-go-name: HealthStatus + host_count: + description: 宿主机数量(不计算虚拟机宿主机数量) + example: 0 + format: int64 + type: integer + x-go-name: HostCount + iam_login_url: + description: 公有云子账号登录地址 + type: string + x-go-name: IamLoginUrl + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_on_premise: + description: 是否是本地IDC账号 + example: false + type: boolean + x-go-name: IsOnPremise + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_public_cloud: + description: 是否是公有云账号 + example: true + type: boolean + x-go-name: IsPublicCloud + lake_of_permissions: + $ref: '#/definitions/SAccountPermissions' + last_sync: + format: date-time + type: string + x-go-name: LastSync + last_sync_end_at: + description: = Column(DateTime, nullable=True) + format: date-time + type: string + x-go-name: LastSyncEndAt + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + options: + description: 额外信息 + type: object + x-go-name: Options + probe_at: + description: 上次账号探测时间 + format: date-time + type: string + x-go-name: ProbeAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_mapping_id: + type: string + x-go-name: ProjectMappingId + projects: + description: 子订阅项目信息 + items: + $ref: '#/definitions/ProviderProject' + type: array + x-go-name: Projects + provider: + description: 云平台类型 + example: google + type: string + x-go-name: Provider + provider_count: + description: 子订阅数量 + example: 1 + format: int64 + type: integer + x-go-name: ProviderCount + proxy_setting: + $ref: '#/definitions/SProxySetting' + proxy_setting_id: + description: 默认值proxyapi.ProxySettingId_DIRECT + type: string + x-go-name: ProxySettingId + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + read_only: + type: boolean + x-go-name: ReadOnly + routetable_count: + description: 路由表数量 + example: 0 + format: int64 + type: integer + x-go-name: RoutetableCount + saml_auth: + type: boolean + x-go-name: SAMLAuth + secret: + description: 云账号密码 + type: string + x-go-name: Secret + share_mode: + default: '"false" nullable:"false"`' + description: for backward compatiblity, keep is_public field, but not usable + type: string + x-go-name: ShareMode + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + storage_count: + description: 块存储数量 + example: 12 + format: int64 + type: integer + x-go-name: StorageCount + storagecache_count: + description: 存储缓存数量 + example: 10 + format: int64 + type: integer + x-go-name: StoragecacheCount + sub_accounts: + $ref: '#/definitions/SubAccounts' + sync_interval_seconds: + description: 同步时间间隔 + example: 3600 + format: int64 + type: integer + x-go-name: SyncIntervalSeconds + sync_status: + type: string + x-go-name: SyncStatus + sync_stauts2: + description: 同步状态 + type: string + x-go-name: SyncStatus2 + sysinfo: + description: 云系统信息 + type: object + x-go-name: Sysinfo + tenant: + description: 云账号项目名称 + example: system + type: string + x-go-name: Tenant + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + version: + description: 云API版本 + type: string + x-go-name: Version + vpc_count: + description: 虚拟私有网络数量 + example: 4 + format: int64 + type: integer + x-go-name: VpcCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountPerformPrepareNetsInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + As: + description: 弹性伸缩服务 + type: string + Bms: + description: 裸金属服务器 + type: string + Bss: + description: 合作伙伴运营能力 + type: string + Cce: + description: 云容器服务 + type: string + Cci: + description: 云容器实例 CCI + type: string + Ces: + description: 监控服务 CloudEye + type: string + Csbs: + description: 云服务器备份服务 + type: string + Cts: + description: 云审计服务 + type: string + Dcs: + description: 分布式缓存服务 + type: string + DefaultRegion: + description: 默认区域Id, Apara及HCSO需要此参数 + example: cn-north-2 + type: string + DefaultSubnetDns: + description: 默认DNS + example: 10.125.0.26,10.125.0.27 + type: string + Ecs: + description: 弹性云服务 + type: string + Elb: + description: 弹性负载均衡 ELB + type: string + EndpointDomain: + description: 华为私有云Endpoint域名 + example: hcso.com.cn + type: string + Eps: + description: 企业项目 + type: string + Evs: + description: 云硬盘 EVS + type: string + Iam: + description: 统一身份认证服务 + type: string + Ims: + description: 镜像服务 + type: string + Modelarts: + description: Modelarts + type: string + Nat: + description: Nat网关 NAT + type: string + Obs: + description: 对象存储服务 OBS + type: string + Rds: + description: 关系型数据库 RDS + type: string + SfsTurbo: + description: 文件系统 + type: string + SkipDuplicateAccountCheck: + description: 跳过重复账号注册检查 + type: boolean + Vbs: + description: 云硬盘备份 VBS + type: string + Vpc: + description: 虚拟私有云 VPC + type: string + access_key_id: + description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeyId + access_key_secret: + description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeySecret + access_url: + description: 认证地址 + type: string + x-go-name: AccessUrl + account: + description: |- + 账号信息，各个平台字段不尽相同，以下是各个平台账号创建所需要的字段 + + + + 云平台 |字段 | 翻译 | 是否必传 | 默认值 | 可否更新 | 获取方式 | + ------ |------ | ------ | --------- | -------- |-------- |-------- | + Aliyun |access_key_id |秘钥ID | 是 | | 是 | | + Aliyun |access_key_secret |秘钥Key | 是 | | 是 | | + Qcloud |app_id |APP ID | 是 | | 否 | | + Qcloud |secret_id |秘钥ID | 是 | | 是 | | + Qcloud |secret_key |秘钥Key | 是 | | 是 | | + OpenStack |project_name |用户所在项目 | 是 | | 是 | | + OpenStack |username |用户名 | 是 | | 是 | | + OpenStack |password |用户密码 | 是 | | 是 | | + OpenStack |auth_url |认证地址 | 是 | | 否 | | + OpenStack |domain_name |用户所在的域 | 否 |Default | 是 | | + VMware |username |用户名 | 是 | | 是 | | + VMware |password |密码 | 是 | | 是 | | + VMware |host |主机IP或域名 | 是 | | 否 | | + VMware |port |主机端口 | 否 |443 | 否 | | + Azure |directory_id |目录ID | 是 | | 否 | | + Azure |environment |区域 | 是 | | 否 | | + Azure |client_id |客户端ID | 是 | | 是 | | + Azure |client_secret |客户端密码 | 是 | | 是 | | + Huawei |access_key_id |秘钥ID | 是 | | 是 | | + Huawei |access_key_secret |秘钥 | 是 | | 是 | | + Huawei |environment |区域 | 是 | | 否 | | + Aws |access_key_id |秘钥ID | 是 | | 是 | | + Aws |access_key_secret |秘钥 | 是 | | 是 | | + Aws |environment |区域 | 是 | | 否 | | + Ucloud |access_key_id |秘钥ID | 是 | | 是 | | + Ucloud |access_key_secret |秘钥 | 是 | | 是 | | + Google |project_id |项目ID | 是 | | 否 | | + Google |client_email |客户端email | 是 | | 否 | | + Google |private_key_id |秘钥ID | 是 | | 是 | | + Google |private_key |秘钥Key | 是 | | 是 | | + type: string + x-go-name: Account + app_id: + description: app id (Qcloud) + type: string + x-go-name: AppId + auto_create_project: + default: false + description: 自动根据云上项目或订阅创建本地项目, OpenStack此参数为true + type: boolean + x-go-name: AutoCreateProject + auto_url: + description: 认证地址 (openstack,zstack) + type: string + x-go-name: AuthUrl + brand: + description: |- + 指定云平台品牌, 此参数默认和provider相同 + requried: false + + + + provider | 支持的参数 | + -------- | ---------- | + VMware | VMware | + Aliyun | Aliyun | + Qcloud | Qcloud | + Azure | Azure | + Aws | Aws | + Huawei | Huawei | + OpenStack | OpenStack | + Ucloud | Ucloud | + ZStack | ZStack, DStack | + Google | Google | + Ctyun | Ctyun | + type: string + x-go-name: Brand + client_id: + description: 客户端ID (Azure) + type: string + x-go-name: ClientId + client_secret: + description: 客户端秘钥 (Azure) + type: string + x-go-name: ClientSecret + crm_biz_id: + description: customInfo type=1 + type: string + x-go-name: CrmBizId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + directory_id: + description: 目录ID (Azure) + type: string + x-go-name: DirectoryId + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + domain_name: + default: Default + description: 账号所在的域 (openstack) + type: string + x-go-name: DomainName + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + dvs: + type: boolean + x-go-name: Dvs + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + endpoint: + description: 端点 (s3) 或 Apsara(飞天) + type: string + x-go-name: Endpoint + environment: + description: 环境 (Azure, Aws, huawei, ctyun, aliyun) + type: string + x-go-name: Environment + gcp_client_email: + description: Google服务账号email (gcp) + type: string + x-go-name: GCPClientEmail + gcp_private_key: + description: Google服务账号秘钥 (gcp) + type: string + x-go-name: GCPPrivateKey + gcp_private_key_id: + description: Google服务账号秘钥id (gcp) + type: string + x-go-name: GCPPrivateKeyId + gcp_project_id: + description: Google服务账号project id (gcp) + type: string + x-go-name: GCPProjectId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + host: + description: 主机IP (esxi) + type: string + x-go-name: Host + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + options: + description: 额外信息,例如账单的access key + type: object + x-go-name: Options + organization_id: + description: 飞天允许的最高组织id, 默认为1 + format: int64 + type: integer + x-go-name: OrganizationId + password: + description: 密码 (openstack, zstack, esxi) + type: string + x-go-name: Password + port: + description: 主机端口 (esxi) + format: int64 + type: integer + x-go-name: Port + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_mapping_id: + type: string + x-go-name: ProjectMappingId + project_name: + description: 账号所在的项目 (openstack) + type: string + x-go-name: ProjectName + provider: + description: |- + 指定云平台 + Qcloud: 腾讯云 + Ctyun: 天翼云 + enum: + - VMware + - ' Aliyun' + - ' Qcloud' + - ' Azure' + - ' Aws' + - ' Huawei' + - ' OpenStack' + - ' Ucloud' + - ' ZStack' + - ' Google' + - ' Ctyun' + - ' JDcloud' + type: string + x-go-name: Provider + proxy_setting_id: + description: 代理配置 + type: string + x-go-name: ProxySettingId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + read_only: + type: boolean + x-go-name: ReadOnly + saml_auth: + default: false + description: 是否启用SAML认证 + type: boolean + x-go-name: SAMLAuth + secret_id: + description: 秘钥ID (Qcloud) + type: string + x-go-name: SecretId + secret_key: + description: 秘钥key (Qcloud) + type: string + x-go-name: SecretKey + show_sub_accounts: + description: 仅当show_sub_accounts=true并且dry_run=true时才返回sub accounts 信息, 且不会创建云账号 + type: boolean + x-go-name: ShowSubAccounts + start_sync: + description: 是否立即开始同步资源 + type: boolean + x-go-name: StartSync + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + username: + description: 用户名 (openstack, zstack, esxi) + type: string + x-go-name: Username + wire_level_for_vmware: + type: string + x-go-name: WireLevelForVmware + zone: + description: VMware 账号有zone属性 + type: string + x-go-name: Zone + required: + - name + - EndpointDomain + - DefaultRegion + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountPerformPrepareNetsOutput: + properties: + hosts: + items: + $ref: '#/definitions/CAGuestNet' + type: array + x-go-name: Hosts + vswitchs: + items: + $ref: '#/definitions/VSwitch' + type: array + x-go-name: VSwitchs + wire_networks: + items: + $ref: '#/definitions/CAWireNet' + type: array + x-go-name: CAWireNets + wires: + description: Guests []CAGuestNet `json:"guests"` + items: + $ref: '#/definitions/CAPWire' + type: array + x-go-name: Wires + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountPerformPublicInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + share_mode: + description: 共享模式，可能值为provider_domain, system + example: provider_domain + type: string + x-go-name: ShareMode + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountProjectMappingInput: + properties: + auto_create_project: + type: boolean + x-go-name: AutoCreateProject + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + project_id: + type: string + x-go-name: ProjectId + project_mapping_id: + description: |- + 同步策略Id, 若不传此参数则解绑 + 绑定同步策略要求当前云账号此刻未绑定其他同步策略 + type: string + x-go-name: ProjectMappingId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountShareModeInput: + properties: + ShareMode: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountSyncSkusInput: + properties: + Force: + type: boolean + Resource: + type: string + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudaccountUpdateInput: + properties: + clean_lake_of_permissions: + description: 临时清除缺失的权限提示，云账号权限缺失依然会自动刷新 + type: boolean + x-go-name: CleanLakeOfPermissions + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + options: + description: 待更新的options key/value + type: object + x-go-name: Options + proxy_setting_id: + description: 代理配置 + type: string + x-go-name: ProxySettingId + read_only: + type: boolean + x-go-name: ReadOnly + remove_options: + description: 带删除的options key + items: + type: string + type: array + x-go-name: RemoveOptions + saml_auth: + type: boolean + x-go-name: SAMLAuth + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderDetails: + properties: + LastSyncCost: + description: 上次同步耗时 + type: string + ProjectMapping: + type: string + access_url: + type: string + x-go-name: AccessUrl + account: + description: 云账号的用户信息，例如用户名，access key等 + type: string + x-go-name: Account + brand: + description: 子订阅品牌信息 + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capabilities: + description: 支持服务列表 + items: + type: string + type: array + x-go-name: Capabilities + cloudaccount: + description: 云账号名称 + example: google-account + type: string + x-go-name: Cloudaccount + cloudaccount_id: + description: 归属云账号ID + type: string + x-go-name: CloudaccountId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + dbinstance_count: + description: 数据库实例数量 + example: 2 + format: int64 + type: integer + x-go-name: DBInstanceCount + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + eip_count: + description: 弹性公网IP数量 + example: 12 + format: int64 + type: integer + x-go-name: EipCount + elasticcache_count: + description: 弹性缓存实例数量 + example: 2 + format: int64 + type: integer + x-go-name: ElasticcacheCount + enable_project_sync: + type: boolean + x-go-name: EnableProjectSync + enable_resource_sync: + type: boolean + x-go-name: EnableResourceSync + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + guest_count: + description: 云主机数量 + example: 1 + format: int64 + type: integer + x-go-name: GuestCount + health_status: + description: |- + 云端服务健康状态。例如欠费、项目冻结都属于不健康状态。 + HealthStatus | 说明 | + ---------------|----------------------| + normal | 远端处于健康状态 | + insufficient | 不足按需资源余额 | + suspended | 远端处于冻结状态 | + arrears | 远端处于欠费状态 | + unknown | 未知状态，查询失败 | + no permission | 没有权限获取账单信息 | + type: string + x-go-name: HealthStatus + host_count: + description: 宿主机数量 + example: 2 + format: int64 + type: integer + x-go-name: HostCount + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_sync: + format: date-time + type: string + x-go-name: LastSync + last_sync_end_at: + description: = Column(DateTime, nullable=True) + format: date-time + type: string + x-go-name: LastSyncEndAt + loadbalancer_count: + description: 负载均衡器数量 + example: 2 + format: int64 + type: integer + x-go-name: LoadbalancerCount + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_count: + description: 项目数量 + format: int64 + type: integer + x-go-name: ProjectCount + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_mapping_id: + type: string + x-go-name: ProjectMappingId + provider: + description: 云账号的平台信息 + type: string + x-go-name: Provider + proxy_setting: + $ref: '#/definitions/SProxySetting' + read_only: + type: boolean + x-go-name: ReadOnly + secret: + description: 云账号的密码信息，例如密码，access key secret等。该字段在数据库加密存储。Google需要存储秘钥证书,需要此字段比较长 + type: string + x-go-name: Secret + snapshot_count: + description: 快照数量 + example: 0 + format: int64 + type: integer + x-go-name: SnapshotCount + status: + description: 资源状态 + type: string + x-go-name: Status + storage_count: + description: 块存储梳理 + example: 4 + format: int64 + type: integer + x-go-name: StorageCount + storagecache_count: + description: 存储缓存数量 + example: 1 + format: int64 + type: integer + x-go-name: StorageCacheCount + sync_region_count: + description: 同步区域数量 + format: int64 + type: integer + x-go-name: SyncRegionCount + sync_status: + type: string + x-go-name: SyncStatus + sync_status2: + description: 子订阅同步状态 + type: string + x-go-name: SyncStatus2 + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc_count: + description: 虚拟私有网络数量 + example: 4 + format: int64 + type: integer + x-go-name: VpcCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderGetCannedAclOutput: + properties: + bucket_canned_acls: + description: Bucket支持的预置ACL列表 + items: + type: string + type: array + x-go-name: BucketCannedAcls + object_canned_acls: + description: Object支持的预置ACL列表 + items: + type: string + type: array + x-go-name: ObjectCannedAcls + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderGetStorageClassOutput: + properties: + storage_classes: + description: 对象存储存储类型 + items: + type: string + type: array + x-go-name: StorageClasses + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderSync: + properties: + cloudregion_ids: + description: 指定区域信息 + items: + type: string + type: array + x-go-name: CloudregionIds + enabled: + default: false + description: 指定区域启用或禁用同步 + type: boolean + x-go-name: Enabled + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudproviderregionDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capabilities: + description: 支持服务列表 + items: + type: string + type: array + x-go-name: Capabilities + cloudaccount: + description: 云账号名称 + example: googl-account + type: string + x-go-name: Cloudaccount + cloudaccount_domain_id: + description: 云账号所在域Id + example: 0df40413-eb69-49c7-895e-618ddeb80f55 + type: string + x-go-name: CloudaccountDomainId + cloudaccount_id: + description: 云账号Id + example: fa4aaf88-aed8-422d-84e7-56dea533b364 + type: string + x-go-name: CloudaccountId + cloudprovider: + type: string + x-go-name: Cloudprovider + cloudprovider_sync_status: + description: 云订阅同步状态 + type: string + x-go-name: CloudproviderSyncStatus + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + last_sync_cost: + description: 上次同步耗时 + type: string + x-go-name: LastSyncCost + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudregionDetails: + properties: + City: + description: 城市 + example: Guiyang + type: string + CountryCode: + description: 国家代码 + example: CN + type: string + Latitude: + description: 纬度 + example: 26.647003 + format: float + type: number + Longitude: + description: 经度 + example: 106.630211 + format: float + type: number + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云类型, public, private or onpremise + example: public + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: 云环境 + example: ChinaCloud + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + guest_count: + description: 云主机梳理 + example: 2 + format: int64 + type: integer + x-go-name: GuestCount + guest_increment_count: + description: 距离前天0点新增云主机数量 + example: 0 + format: int64 + type: integer + x-go-name: GuestIncrementCount + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network_count: + description: IP子网数量 + example: 12 + format: int64 + type: integer + x-go-name: NetworkCount + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台 + example: Huawei + type: string + x-go-name: Provider + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc_count: + description: 虚拟私有网络数量 + example: 2 + format: int64 + type: integer + x-go-name: VpcCount + zone_count: + description: 可用区数量 + example: 3 + format: int64 + type: integer + x-go-name: ZoneCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CloudregionSkuSyncInput: + properties: + cloudregion_ids: + description: 区域ID + items: + type: string + type: array + x-go-name: CloudregionIds + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + resource: + description: |- + 同步资源类型 + choices: serversku|elasticcachesku|dbinstance_sku + type: string + x-go-name: Resource + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ConvertEsxiToKvmInput: + properties: + prefer_host: + description: 指定转换的宿主机 + type: string + x-go-name: PreferHost + target_hypervisor: + description: target hypervisor + type: string + x-go-name: TargetHypervisor + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CycleTimerCreateInput: + properties: + cycle_type: + description: 'description: 周期类型' + enum: + - day + - week + - month + type: string + x-go-name: CycleType + end_time: + description: 'description: 截止时间' + format: date-time + type: string + x-go-name: EndTime + hour: + description: 'description: 时(0-23)' + example: 13 + format: int64 + type: integer + x-go-name: Hour + minute: + description: 'description: 分(0-59)' + example: 13 + format: int64 + type: integer + x-go-name: Minute + month_days: + description: 'description: 每月的哪几天; 1-31' + example: + - 1 + - 4 + - 31 + items: + format: int64 + type: integer + type: array + x-go-name: MonthDays + start_time: + description: 'description: 开始时间' + format: date-time + type: string + x-go-name: StartTime + week_days: + description: 'description: 每周的周几; 1-7, 1: Monday, 7: Sunday' + example: + - 1 + - 3 + - 5 + - 7 + items: + format: int64 + type: integer + type: array + x-go-name: WeekDays + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + CycleTimerDetails: + properties: + cycle_type: + description: 'description: 周期类型：按天/周/月' + type: string + x-go-name: CycleType + end_time: + description: 'description: 此周期任务的截止时间' + format: date-time + type: string + x-go-name: EndTime + hour: + description: 'description: 小时' + format: int64 + type: integer + x-go-name: Hour + minute: + description: 'description: 分钟' + format: int64 + type: integer + x-go-name: Minute + month_days: + description: 'description: 每月的几天' + items: + format: int64 + type: integer + type: array + x-go-name: MonthDays + start_time: + description: 'description: 此周期任务的开始时间' + format: date-time + type: string + x-go-name: StartTime + week_days: + description: 'description: 每周的几天' + items: + format: int64 + type: integer + type: array + x-go-name: WeekDays + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceAccountCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + dbinstance: + description: |- + rds实例名称或Id,建议使用Id + + + + 平台 |支持Rds引擎 | + ---- |------- | + Aliyun |MySQL, MariaBD, SQLServer | + 华为云 |MySQL, MariaBD | + 腾讯云 |MySQL | + type: string + x-go-name: DBInstance + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + password: + description: 账号密码，若不指定,则会随机生成 + type: string + x-go-name: Password + privileges: + description: 账号权限 + items: + $ref: '#/definitions/SDBInstanceAccountPrivilege' + type: array + x-go-name: Privileges + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - dbinstance + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceAccountDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + dbinstance: + description: RDS实例名称 + type: string + x-go-name: DBInstance + dbinstance_id: + type: string + x-go-name: DBInstanceId + dbinstanceprivileges: + description: 账号权限列表 + items: + $ref: '#/definitions/DBInstancePrivilege' + type: array + x-go-name: DBInstanceprivileges + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + host: + type: string + x-go-name: Host + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secret: + description: 数据库密码 + type: string + x-go-name: Secret + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceAccountUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceAutoRenewInput: + properties: + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceBackupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + databases: + description: 需要备份的Rds数据库列表 + items: + type: string + type: array + x-go-name: Databases + dbinstance: + description: Rds实例名称或Id, 建议使用Id + type: string + x-go-name: DBInstance + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - dbinstance + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceBackupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + backup_method: + description: 备份方式 Logical|Physical + type: string + x-go-name: BackupMethod + backup_mode: + description: 备份模式 + type: string + x-go-name: BackupMode + backup_size_mb: + description: 备份大小 + example: 32 + format: int64 + type: integer + x-go-name: BackupSizeMb + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + db_names: + description: 备份数据库名称 + type: string + x-go-name: DBNames + dbinstance: + description: RDS实例名称 + type: string + x-go-name: DBInstance + dbinstance_id: + type: string + x-go-name: DBInstanceId + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + end_time: + description: 备份结束时间 + format: date-time + type: string + x-go-name: EndTime + engine: + description: RDS引擎 + example: MySQL + type: string + x-go-name: Engine + engine_version: + description: RDS引擎版本 + example: "5.7" + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + start_time: + description: 备份开始时间 + format: date-time + type: string + x-go-name: StartTime + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + BillingType: + description: 计费方式 + enum: + - postpaid + - ' prepaid' + type: string + address: + description: Ip子网内的地址,不填则按照ip子网的地址分配策略分配一个ip + type: string + x-go-name: Address + auto_renew: + default: false + description: 是否自动续费(仅包年包月时生效) + type: boolean + x-go-name: AutoRenew + category: + description: |- + rds类型 + + + + 平台 | 支持类型 | 说明 | + ----- | ------ | --- | + 华为云 |ha, single, replica| ha: 高可用, single: 单机, replica: 只读| + 阿里云 |basic, high_availability, always_on, finance|basic: 基础版, high_availability: 高可用, always_on: 集群版, finance: 金融版, 三节点| + Google |Zonal, Regional | Zonal: 单区域, Regional: 区域级| + 腾讯云 |fe, ha, basic | ha: 高可用, basic: 基础版, fe: 金融版| + type: string + x-go-name: Category + dbinstancebackup_id: + description: 从备份中创建新实例 + type: string + x-go-name: DBInstancebackupId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + disk_size_gb: + description: |- + rds存储大小 + 可参考rds套餐的大小范围和步长情况 + format: int64 + type: integer + x-go-name: DiskSizeGB + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时间周期 + type: string + x-go-name: Duration + engine: + description: rds引擎 + enum: + - MySQL + - ' SQLServer' + - ' PostgreSQL' + - ' MariaDB' + - ' Oracle' + - ' PPAS' + type: string + x-go-name: Engine + engine_version: + description: |- + rds引擎版本 + 根据各个引擎版本各不相同 + type: string + x-go-name: EngineVersion + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + instance_type: + description: |- + 套餐名称, 若此参数不填, 则必须有vmem_size_mb及vcpu_count参数 + 套餐列表可以通过 dbinstancesku 获取 + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + master_instance: + description: |- + rds实例名称或Id,建议使用Id + 创建只读实例时此参数必传 + type: string + x-go-name: MasterInstance + multi_az: + description: 多可用区部署 + type: boolean + x-go-name: MultiAZ + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_id: + description: |- + Ip子网名称或Id,建议使用Id + 谷歌云并不实际使用Ip子网,仅仅通过Ip子网确定Vpc + type: string + x-go-name: NetworkId + password: + description: |- + rds初始化密码 + 阿里云不需要此参数 + 华为云会默认创建一个用户,若不传此参数, 则为随机密码 + 谷歌云会默认创建一个用户,若不传此参数, 则为随机密码 + 腾讯云会默认创建一个用户,若不传此参数, 则为随机密码 + type: string + x-go-name: Password + port: + description: 指定连接端口 + format: int64 + type: integer + x-go-name: Port + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + reset_password: + description: |- + 是否不设置初始密码 + 华为云不支持此参数 + 谷歌云仅mysql支持此参数 + type: boolean + x-go-name: ResetPassword + secgroup_ids: + description: |- + 安全组Id列表 + + + 云平台 | 最大支出安全组数量 | + -------------|---------- | + 腾讯云 | 5 | + 华为云 | 1 | + 阿里云 | 不支持 | + items: + type: string + type: array + x-go-name: SecgroupIds + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_type: + description: |- + rds存储类型 + + + + 平台 | 支持类型 | 说明 | + ----- | ------ | --- | + 华为云 |SSD, SAS, SATA| | + 阿里云 |local_ssd, cloud_essd, cloud_ssd| | + Google |PD_SSD, PD_HDD| PD_SSD: SSD, PD_HDD: HDD| + 腾讯云 |cloud_ssd, local_ssd| | + type: string + x-go-name: StorageType + vcpu_count: + description: |- + rds实例cpu大小 + 若指定实例套餐，此参数将根据套餐设置 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size_mb: + description: |- + rds实例内存大小 + 若指定实例套餐，此参数将根据套餐设置 + format: int64 + type: integer + x-go-name: VmemSizeMb + zone1: + description: 主可用区名称或Id, 此参数从指定的套餐所在的可用区获取 + type: string + x-go-name: Zone1 + zone2: + description: 次可用区名称或Id, 此参数从指定的套餐所在的可用区获取 + type: string + x-go-name: Zone2 + zone3: + description: 三节点可用区名称或Id,, 此参数从指定的套餐所在的可用区获取 + type: string + x-go-name: Zone3 + required: + - name + - network_id + - engine + - engine_version + - category + - storage_type + - disk_size_gb + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceDatabaseCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + accounts: + description: 赋予账号权限 + items: + $ref: '#/definitions/SDBInstanceDatabasePrivilege' + type: array + x-go-name: Accounts + character_set: + description: 数据库字符集 + type: string + x-go-name: CharacterSet + dbinstance: + description: |- + rds实例名称或Id,建议使用Id + + + + 平台 |支持Rds引擎 | + ---- |------- | + Aliyun |MySQL, MariaBD, SQLServer | + 华为云 |MySQL, MariaBD | + 腾讯云 | | + type: string + x-go-name: DBInstance + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - dbinstance + - character_set + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceDatabaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + category: + description: 实例类型 + example: ha + type: string + x-go-name: Category + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + connection_str: + description: 外部连接地址 + type: string + x-go-name: ConnectionStr + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + databases: + items: + $ref: '#/definitions/IdNameDetails' + type: array + x-go-name: Databases + dbinstancebackup_id: + description: 从备份创建新实例 + type: string + x-go-name: DBInstancebackupId + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + disk_size_gb: + description: 存储大小 + example: 10240 + format: int64 + type: integer + x-go-name: DiskSizeGB + disk_size_used_mb: + description: 已使用的存储大小 + format: int64 + type: integer + x-go-name: DiskSizeUsedMB + domain_id: + description: 域Id + type: string + x-go-name: DomainId + engine: + description: 引擎 + example: MySQL + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + example: "5.7" + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + example: mysql.x4.large.2c + type: string + x-go-name: InstanceType + internal_connection_str: + description: 内部连接地址 + type: string + x-go-name: InternalConnectionStr + iops: + description: iops + example: 0 + format: int64 + type: integer + x-go-name: Iops + ip_addrs: + description: 内网IP地址, 若有多个以 ',' 分隔 + type: string + x-go-name: IpAddrs + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + maintain_time: + description: 维护时间 + type: string + x-go-name: MaintainTime + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + master_instance_id: + description: 主实例Id + type: string + x-go-name: MasterInstanceId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: IP子网名称, 若有多个以 ',' 分隔 + example: test-network + type: string + x-go-name: Network + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + port: + description: 端口 + example: 3306 + format: int64 + type: integer + x-go-name: Port + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secgroup: + description: 安全组名称 + example: Default + type: string + x-go-name: Secgroup + secgroups: + items: + $ref: '#/definitions/StandaloneShortDesc' + type: array + x-go-name: Secgroups + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + description: 存储类型 + example: local_ssd + type: string + x-go-name: StorageType + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vcpu_count: + description: CPU数量 + example: 1 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size_mb: + description: 内存大小 + example: 1024 + format: int64 + type: integer + x-go-name: VmemSizeMb + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 虚拟私有网络Id + example: ed20d84e-3158-41b1-870c-1725e412e8b6 + type: string + x-go-name: VpcId + zone1: + description: 可用区1 + type: string + x-go-name: Zone1 + zone1_name: + description: Zone1名称 + type: string + x-go-name: Zone1Name + zone2: + description: 可用区2 + type: string + x-go-name: Zone2 + zone2_name: + description: Zone2名称 + type: string + x-go-name: Zone2Name + zone3: + description: 可用区3 + type: string + x-go-name: Zone3 + zone3_name: + description: Zone3名称 + type: string + x-go-name: Zone3Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstancePrivilege: + properties: + account: + description: 账号名称 + type: string + x-go-name: Account + database: + description: 数据库名称 + type: string + x-go-name: Database + dbinstancedatabase_id: + description: 数据库Id + type: string + x-go-name: DBInstancedatabaseId + privileges: + description: 权限 + type: string + x-go-name: Privileges + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceSecgroupDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + dbinstance: + description: RDS名称 + type: string + x-go-name: DBInstance + delete_fail_reason: + $ref: '#/definitions/Error' + secgroup: + description: 安全组名称 + type: string + x-go-name: Secgroup + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceSetSecgroupInput: + properties: + secgroup_ids: + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceSkuDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + category: + type: string + x-go-name: Category + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disk_size_step: + format: int64 + type: integer + x-go-name: DiskSizeStep + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + engine: + type: string + x-go-name: Engine + engine_version: + type: string + x-go-name: EngineVersion + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + iops: + format: int64 + type: integer + x-go-name: IOPS + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + max_connections: + format: int64 + type: integer + x-go-name: MaxConnections + max_disk_size_gb: + description: 步长 + format: int64 + type: integer + x-go-name: MaxDiskSizeGb + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + min_disk_size_gb: + format: int64 + type: integer + x-go-name: MinDiskSizeGb + multi_az: + type: boolean + x-go-name: MultiAZ + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + type: string + x-go-name: Provider + qps: + format: int64 + type: integer + x-go-name: QPS + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + type: string + x-go-name: StorageType + tps: + format: int64 + type: integer + x-go-name: TPS + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vcpu_count: + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size_mb: + format: int64 + type: integer + x-go-name: VmemSizeMb + zone_id: + type: string + x-go-name: ZoneId + zone1: + type: string + x-go-name: Zone1 + zone1_name: + type: string + x-go-name: Zone1Name + zone2: + type: string + x-go-name: Zone2 + zone2_name: + type: string + x-go-name: Zone2Name + zone3: + type: string + x-go-name: Zone3 + zone3_name: + type: string + x-go-name: Zone3Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstancedatabaseDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + character_set: + description: 字符集 + example: utf-8 + type: string + x-go-name: CharacterSet + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + dbinstance: + description: RDS实例名称 + type: string + x-go-name: DBInstance + dbinstance_id: + type: string + x-go-name: DBInstanceId + dbinstanceprivileges: + description: 数据库权限 + items: + $ref: '#/definitions/DBInstancePrivilege' + type: array + x-go-name: DBInstanceprivileges + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DBInstanceparameterDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + dbinstance: + description: RDS实例名称 + type: string + x-go-name: DBInstance + dbinstance_id: + type: string + x-go-name: DBInstanceId + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + key: + description: 数据库参数名称 + type: string + x-go-name: Key + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + value: + description: 数据库参数值 + type: string + x-go-name: Value + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DefaultAction: + description: +onecloud:model-api-gen + properties: + Action: + $ref: '#/definitions/TWafAction' + InsertHeaders: + additionalProperties: + type: string + description: 仅Action为Allow时生效 + type: object + Response: + description: 仅Action为Block时生效 + type: string + ResponseCode: + description: 仅Action为Block时生效 + format: int64 + type: integer + ResponseHeaders: + additionalProperties: + type: string + description: 仅Action为Block时生效 + type: object + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + DeployConfig: + properties: + action: + type: string + x-go-name: Action + content: + type: string + x-go-name: Content + path: + type: string + x-go-name: Path + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskBackupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + back_storage_id: + description: 'description: backup storage id' + type: string + x-go-name: BackupStorageId + cloudregion_id: + description: 'swagger: ignore' + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_id: + description: 'description: disk id' + type: string + x-go-name: DiskId + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskBackupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + backup_storage_name: + description: 'description: backup storage name' + type: string + x-go-name: BackupStorageName + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + disk_name: + description: 'description: disk name' + type: string + x-go-name: DiskName + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + is_sub_backup: + description: 'description: 是否是子备份' + type: boolean + x-go-name: IsSubBackup + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskBackupRecoveryInput: + properties: + Name: + description: 'description: name of disk' + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskBackupSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskConfig: + properties: + backend: + description: |- + 后端存储类型,若指定了存储ID,此参数会根据存储设置,若不指定，则作为调度的一个参考 + + + + 平台 | 存储类型 | 中文 | 数据盘 | 系统盘 | 可否扩容 | 可否单独创建 | 扩容步长 | 说明 | + ---- | ---- | ---- | ----- | ----- | ------- | ----------- | ------- | ----- | + Esxi |local |本地盘 |1-500GB |30~500GB | 是 | 否 | 1G | | + Esxi |nas |NAS盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | + Esxi |vsan |VSAN盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | + KVM |local |本地盘盘 |1-500GB |30~500GB | 是 | 否 | 1G | | + KVM |rbd |云硬盘 |1-3072GB |30~500GB | 是 | 是 | 1G | | + Azure |standard_lrs |标准 HDD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + Azure |standardssd_lrs |标准 SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + Azure |premium_lrs |高级SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + AWS |gp2 |通用型SSD |1-16384GB |20~16384GB | 是 | 是 | 1G | | + AWS |io1 |预配置 IOPS SSD |4-16384GB |20-16384GB | 是 | 是 | 1G | | + AWS |st1 |吞吐优化HDD |500-16384GB |不支持 | 是 | 是 | 1G | | + AWS |sc1 |Cold HDD |500-16384GB |不支持 | 是 | 是 | 1G | | + AWS |standard |磁介质 |1-1024GB |20-1024GB | 是 | 是 | 1G | | + 腾讯云 |cloud_ssd |SSD云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | + 腾讯云 |cloud_basic |普通云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | + 腾讯云 |cloud_preium |高性能云硬盘 |10-16000GB |50~1024GB | 是 | 是 | 10G | | + 腾讯云 |local_basic |普通本地盘 |10-1600GB |不支持 | 否 | 否 | | | + 腾讯云 |local_ssd |SSD本地盘 |10-7000GB |部分区域套餐支持 | 否 | 否 | | | + 腾讯云 |local_pro |HDD本地盘 |跟随套餐 |部分区域套餐支持 | 否 | 否 | | | + 华为云或天翼云 |SSD |超高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + 华为云或天翼云 |SAS |高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + 华为云或天翼云 |SATA |普通IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + OpenStack |nova |nova |不支持 |30-500GB | 否 | 否 | | | + OpenStack |自定义 |... |无限制 |无限制 | 是 | 是 | 1G | | + Ucloud |CLOUD_NORMAL |普通云盘 |20-8000GB |不支持 | 是 | 是 | 1G | | + Ucloud |CLOUD_SSD |SSD云盘 |20-4000GB |20-500GB | 是 | 是 | 1G | | + Ucloud |LOCAL_NORMAL |普通本地盘 | | | 是 | 是 | 1G | | + Ucloud |LOCAL_SSD |SSD本地盘 | | | 是 | 是 | 1G | | + Ucloud |EXCLUSIVE_LOCAL_DISK |独享本地盘 | | | 是 | 是 | 1G | | + ZStack |localstorage |本地盘 | | | 是 | 是 | 1G | | + ZStack |ceph |云硬盘 | | | 是 | 是 | 1G | | + Google |local-ssd |本地SSD暂存盘 |375GB |不支持 | 否 | 否 | | 跟随实例创建，一次最多添加8个 | + Google |pd-standard |标准永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | + Google |pd-ssd |SSD永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | + type: string + x-go-name: Backend + backup_id: + type: string + x-go-name: BackupId + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + cache: + description: 磁盘缓存模式 + enum: + - writeback + - ' none' + - ' writethrough' + type: string + x-go-name: Cache + disk_type: + description: 磁盘类型 + enum: + - sys + - ' data' + - ' swap' + type: string + x-go-name: DiskType + driver: + description: 磁盘驱动方式 + enum: + - virtio + - ' ide' + - ' scsi' + - ' sata' + - ' pvscsi' + type: string + x-go-name: Driver + format: + description: 磁盘存储格式 + enum: + - qcow2 + - ' raw' + - ' docker' + - ' iso' + - ' vmdk' + - ' vmdkflatver1' + - ' vmdkflatver2' + - ' vmdkflat' + - ' vmdksparse' + - ' vmdksparsever1' + - ' vmdksparsever2' + - ' vmdksepsparse vhd' + type: string + x-go-name: Format + fs: + description: 文件系统,仅kvm支持自动格式化磁盘,私有云和公有云此参数不会生效 + enum: + - swap + - ' ext2' + - ' ext3' + - ' ext4' + - ' xfs' + - ' ntfs' + - ' fat' + - ' hfsplus' + type: string + x-go-name: Fs + image_encrypt_key_id: + description: 镜像加密key ID + type: string + x-go-name: ImageEncryptKeyId + image_id: + description: 镜像ID,通过镜像创建磁盘,创建虚拟机时第一块磁盘需要指定此参数 + type: string + x-go-name: ImageId + index: + default: -1 + description: 挂载到虚拟机的磁盘顺序, -1代表不挂载任何虚拟机 + format: int64 + type: integer + x-go-name: Index + medium: + default: hybird + description: |- + 介质类型 + rotate: 机械盘 + ssd: 固态硬盘 + hybird: 混合盘 + emum: [rotate, ssd, hybrid] + type: string + x-go-name: Medium + mountpoint: + description: |- + 挂载点,必须以 '/' 开头,例如 /opt 仅KVM此参数有效 + requried: false + type: string + x-go-name: Mountpoint + nvme_device: + $ref: '#/definitions/IsolatedDeviceConfig' + os_arch: + description: 操作系统CPU架构 + type: string + x-go-name: OsArch + schedtags: + items: + $ref: '#/definitions/SchedtagConfig' + type: array + x-go-name: Schedtags + size: + description: |- + 磁盘大小,单位Mb + 若创建裸金属服务器是, -1代表自动向后扩展存储 + requried:true + format: int64 + type: integer + x-go-name: SizeMb + snapshot_id: + description: 快照ID,通过快照创建磁盘,此参数必须加上 'snapshot-' 前缀 + example: snapshot-3140cecb-ccc4-4865-abae-3a5ba8c69d9b + type: string + x-go-name: SnapshotId + storage_id: + description: |- + 存储ID, 指定存储后，磁盘会在此存储上创建 + 存储列表可以参数 storage 列表API + type: string + x-go-name: Storage + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + backend: + description: |- + 后端存储类型,若指定了存储ID,此参数会根据存储设置,若不指定，则作为调度的一个参考 + + + + 平台 | 存储类型 | 中文 | 数据盘 | 系统盘 | 可否扩容 | 可否单独创建 | 扩容步长 | 说明 | + ---- | ---- | ---- | ----- | ----- | ------- | ----------- | ------- | ----- | + Esxi |local |本地盘 |1-500GB |30~500GB | 是 | 否 | 1G | | + Esxi |nas |NAS盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | + Esxi |vsan |VSAN盘 |30-3072GB |30~500GB | 是 | 否 | 1G | | + KVM |local |本地盘盘 |1-500GB |30~500GB | 是 | 否 | 1G | | + KVM |rbd |云硬盘 |1-3072GB |30~500GB | 是 | 是 | 1G | | + Azure |standard_lrs |标准 HDD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + Azure |standardssd_lrs |标准 SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + Azure |premium_lrs |高级SSD |1-4095GB |30~4095GB | 是 | 是 | 1G | | + AWS |gp2 |通用型SSD |1-16384GB |20~16384GB | 是 | 是 | 1G | | + AWS |io1 |预配置 IOPS SSD |4-16384GB |20-16384GB | 是 | 是 | 1G | | + AWS |st1 |吞吐优化HDD |500-16384GB |不支持 | 是 | 是 | 1G | | + AWS |sc1 |Cold HDD |500-16384GB |不支持 | 是 | 是 | 1G | | + AWS |standard |磁介质 |1-1024GB |20-1024GB | 是 | 是 | 1G | | + 腾讯云 |cloud_ssd |SSD云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | + 腾讯云 |cloud_basic |普通云硬盘 |10-16000GB |50~500GB | 是 | 是 | 10G | | + 腾讯云 |cloud_preium |高性能云硬盘 |10-16000GB |50~1024GB | 是 | 是 | 10G | | + 腾讯云 |local_basic |普通本地盘 |10-1600GB |不支持 | 否 | 否 | | | + 腾讯云 |local_ssd |SSD本地盘 |10-7000GB |部分区域套餐支持 | 否 | 否 | | | + 腾讯云 |local_pro |HDD本地盘 |跟随套餐 |部分区域套餐支持 | 否 | 否 | | | + 华为云或天翼云 |SSD |超高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + 华为云或天翼云 |SAS |高IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + 华为云或天翼云 |SATA |普通IO云硬盘 |10-32768GB |40~1024GB | 是 | 是 | 1G | | + OpenStack |nova |nova |不支持 |30-500GB | 否 | 否 | | | + OpenStack |自定义 |... |无限制 |无限制 | 是 | 是 | 1G | | + Ucloud |CLOUD_NORMAL |普通云盘 |20-8000GB |不支持 | 是 | 是 | 1G | | + Ucloud |CLOUD_SSD |SSD云盘 |20-4000GB |20-500GB | 是 | 是 | 1G | | + Ucloud |LOCAL_NORMAL |普通本地盘 | | | 是 | 是 | 1G | | + Ucloud |LOCAL_SSD |SSD本地盘 | | | 是 | 是 | 1G | | + Ucloud |EXCLUSIVE_LOCAL_DISK |独享本地盘 | | | 是 | 是 | 1G | | + ZStack |localstorage |本地盘 | | | 是 | 是 | 1G | | + ZStack |ceph |云硬盘 | | | 是 | 是 | 1G | | + Google |local-ssd |本地SSD暂存盘 |375GB |不支持 | 否 | 否 | | 跟随实例创建，一次最多添加8个 | + Google |pd-standard |标准永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | + Google |pd-ssd |SSD永久性磁盘 |10-65536GB |10-65536GB | 是 | 是 | 1G | | + type: string + x-go-name: Backend + backup_id: + type: string + x-go-name: BackupId + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + cache: + description: 磁盘缓存模式 + enum: + - writeback + - ' none' + - ' writethrough' + type: string + x-go-name: Cache + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_type: + description: 磁盘类型 + enum: + - sys + - ' data' + - ' swap' + type: string + x-go-name: DiskType + driver: + description: 磁盘驱动方式 + enum: + - virtio + - ' ide' + - ' scsi' + - ' sata' + - ' pvscsi' + type: string + x-go-name: Driver + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + format: + description: 磁盘存储格式 + enum: + - qcow2 + - ' raw' + - ' docker' + - ' iso' + - ' vmdk' + - ' vmdkflatver1' + - ' vmdkflatver2' + - ' vmdkflat' + - ' vmdksparse' + - ' vmdksparsever1' + - ' vmdksparsever2' + - ' vmdksepsparse vhd' + type: string + x-go-name: Format + fs: + description: 文件系统,仅kvm支持自动格式化磁盘,私有云和公有云此参数不会生效 + enum: + - swap + - ' ext2' + - ' ext3' + - ' ext4' + - ' xfs' + - ' ntfs' + - ' fat' + - ' hfsplus' + type: string + x-go-name: Fs + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + hypervisor: + default: kvm + description: 此参数仅适用于未指定storage时进行调度到指定平台创建磁盘 + enum: + - kvm + - ' openstack' + - ' esxi' + - ' aliyun' + - ' aws' + - ' qcloud' + - ' azure' + - ' huawei' + - ' openstack' + - ' ucloud' + - ' zstack google' + - ' ctyun' + type: string + x-go-name: Hypervisor + image_encrypt_key_id: + description: 镜像加密key ID + type: string + x-go-name: ImageEncryptKeyId + image_id: + description: 镜像ID,通过镜像创建磁盘,创建虚拟机时第一块磁盘需要指定此参数 + type: string + x-go-name: ImageId + index: + default: -1 + description: 挂载到虚拟机的磁盘顺序, -1代表不挂载任何虚拟机 + format: int64 + type: integer + x-go-name: Index + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + medium: + default: hybird + description: |- + 介质类型 + rotate: 机械盘 + ssd: 固态硬盘 + hybird: 混合盘 + emum: [rotate, ssd, hybrid] + type: string + x-go-name: Medium + mountpoint: + description: |- + 挂载点,必须以 '/' 开头,例如 /opt 仅KVM此参数有效 + requried: false + type: string + x-go-name: Mountpoint + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + nvme_device: + $ref: '#/definitions/IsolatedDeviceConfig' + os_arch: + description: 操作系统CPU架构 + type: string + x-go-name: OsArch + prefer_host_id: + description: 此参数仅适用于未指定storage时进行调度到指定可用区区创建磁盘 + type: string + x-go-name: PreferHost + prefer_manager_id: + description: 调度使用指定的云账号 + type: string + x-go-name: PreferManager + prefer_region_id: + description: 此参数仅适用于未指定storage时进行调度到指定区域创建磁盘 + type: string + x-go-name: PreferRegion + prefer_zone_id: + description: 此参数仅适用于未指定storage时进行调度到指定可用区区创建磁盘 + type: string + x-go-name: PreferZone + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + schedtags: + items: + $ref: '#/definitions/SchedtagConfig' + type: array + x-go-name: Schedtags + size: + description: |- + 磁盘大小,单位Mb + 若创建裸金属服务器是, -1代表自动向后扩展存储 + requried:true + format: int64 + type: integer + x-go-name: SizeMb + snapshot_id: + description: 快照ID,通过快照创建磁盘,此参数必须加上 'snapshot-' 前缀 + example: snapshot-3140cecb-ccc4-4865-abae-3a5ba8c69d9b + type: string + x-go-name: SnapshotId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_id: + description: |- + 存储ID, 指定存储后，磁盘会在此存储上创建 + 存储列表可以参数 storage 列表API + type: string + x-go-name: Storage + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskDetails: + properties: + access_path: + description: 磁盘路径 + type: string + x-go-name: AccessPath + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + auto_delete: + description: 是否跟随资源自动删除 + example: false + type: boolean + x-go-name: AutoDelete + auto_delete_at: + description: 自动清理时间 + format: date-time + type: string + x-go-name: AutoDeleteAt + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backup_id: + description: 备份Id + type: string + x-go-name: BackupId + backup_storage_id: + description: 备份磁盘实例的存储ID + type: string + x-go-name: BackupStorageId + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disk_format: + description: 磁盘存储类型 + example: qcow2 + type: string + x-go-name: DiskFormat + disk_size: + description: 磁盘大小, 单位Mb + example: 10240 + format: int64 + type: integer + x-go-name: DiskSize + disk_type: + description: |- + 磁盘类型 + sys: 系统盘 + data: 数据盘 + swap: 交换盘 + example: sys + type: string + x-go-name: DiskType + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + fs_format: + description: 文件系统 + type: string + x-go-name: FsFormat + guest: + description: 所挂载的虚拟机 + type: string + x-go-name: Guest + guest_count: + description: 所挂载虚拟机的数量 + format: int64 + type: integer + x-go-name: GuestCount + guest_status: + description: 所挂载虚拟机状态 + type: string + x-go-name: GuestStatus + guests: + description: 所挂载的虚拟机 + items: + $ref: '#/definitions/SimpleGuest' + type: array + x-go-name: Guests + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + iops: + description: 最大连接数 + format: int64 + type: integer + x-go-name: Iops + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_ssd: + description: 是否标记为SSD磁盘 + type: boolean + x-go-name: IsSsd + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + manual_snapshot_count: + description: 手动快照数量 + format: int64 + type: integer + x-go-name: ManualSnapshotCount + max_manual_snapshot_count: + description: 最多可创建手动快照数量 + format: int64 + type: integer + x-go-name: MaxManualSnapshotCount + medium_type: + description: 存储介质类型 + type: string + x-go-name: MediumType + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nonpersistent: + description: '# is persistent' + type: boolean + x-go-name: Nonpersistent + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + snapshot_id: + description: 快照Id + type: string + x-go-name: SnapshotId + snapshotpolicies: + description: 自动快照策略 + items: + $ref: '#/definitions/SimpleSnapshotPolicy' + type: array + x-go-name: Snapshotpolicies + snapshotpolicy_status: + description: 自动快照策略状态 + type: string + x-go-name: SnapshotpolicyStatus + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage: + description: 存储名称 + type: string + x-go-name: Storage + storage_id: + type: string + x-go-name: StorageId + storage_status: + description: 存储状态 + type: string + x-go-name: StorageStatus + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + template_id: + description: 镜像Id + type: string + x-go-name: TemplateId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + throughput: + description: 磁盘吞吐量 + format: int64 + type: integer + x-go-name: Throughput + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskResetInput: + properties: + auto_start: + type: boolean + x-go-name: AutoStart + snapshot_id: + type: string + x-go-name: SnapshotId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskResizeInput: + properties: + size: + description: 'default unit: Mb' + example: 1024; 40G; 1024M + type: string + x-go-name: Size + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskSaveInput: + properties: + Format: + type: string + ImageId: + description: 'swagger: ignore' + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DiskUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + disk_type: + description: 磁盘类型 + type: string + x-go-name: DiskType + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + records: + type: string + x-go-name: Records + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + ttl: + description: DNS记录的过期时间，单位为秒 + example: 60 + format: int64 + type: integer + x-go-name: Ttl + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordPolicy: + properties: + policy_options: + type: object + x-go-name: PolicyOptions + policy_type: + type: string + x-go-name: PolicyType + policy_value: + type: string + x-go-name: PolicyValue + provider: + description: 平台 + type: string + x-go-name: Provider + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordSetCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dns_type: + type: string + x-go-name: DnsType + dns_value: + type: string + x-go-name: DnsValue + dns_zone_id: + type: string + x-go-name: DnsZoneId + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + mx_priority: + format: int64 + type: integer + x-go-name: MxPriority + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + traffic_policies: + items: + $ref: '#/definitions/DnsRecordPolicy' + type: array + x-go-name: TrafficPolicies + ttl: + format: int64 + type: integer + x-go-name: TTL + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordSetDetails: + properties: + TrafficPolicies: + items: + $ref: '#/definitions/DnsRecordPolicy' + type: array + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + dns_type: + type: string + x-go-name: DnsType + dns_value: + type: string + x-go-name: DnsValue + dns_zone: + type: string + x-go-name: DnsZone + dns_zone_id: + type: string + x-go-name: DnsZoneId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mx_priority: + format: int64 + type: integer + x-go-name: MxPriority + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + status: + description: 资源状态 + type: string + x-go-name: Status + ttl: + format: int64 + type: integer + x-go-name: TTL + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordSetTrafficPoliciesInput: + properties: + traffic_policies: + items: + $ref: '#/definitions/DnsRecordPolicy' + type: array + x-go-name: TrafficPolicies + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsRecordSetUpdateInput: + properties: + TrafficPolicies: + items: + $ref: '#/definitions/DnsRecordPolicy' + type: array + description: + description: 资源描述 + type: string + x-go-name: Description + dns_type: + type: string + x-go-name: DnsType + dns_value: + type: string + x-go-name: DnsValue + mx_priority: + format: int64 + type: integer + x-go-name: MxPriority + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + ttl: + format: int64 + type: integer + x-go-name: TTL + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsTrafficPolicyCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + options: + description: 额外参数 + type: object + x-go-name: Options + policy_type: + type: string + x-go-name: PolicyType + policy_value: + type: string + x-go-name: PolicyValue + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + provider: + type: string + x-go-name: Provider + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsTrafficPolicyDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + options: + type: object + x-go-name: Options + policy_type: + type: string + x-go-name: PolicyType + policy_value: + type: string + x-go-name: PolicyValue + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneAddVpcsInput: + properties: + vpc_ids: + description: VPC id列表 + items: + type: string + type: array + x-go-name: VpcIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneCacheCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneCacheDetails: + properties: + Account: + type: string + Brand: + type: string + Provider: + type: string + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudaccount_id: + description: 归属云账号ID + type: string + x-go-name: CloudaccountId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + dns_zone_id: + type: string + x-go-name: DnsZoneId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + product_type: + type: string + x-go-name: ProductType + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneCacheInput: + properties: + CloudaccountId: + description: |- + 云账号Id + + + 要求 | + ---------- | + 1. dns zone 状态必须为available | + 2. dns zone zone_type 必须为PublicZone | + 3. 指定云账号未在云上创建相应的 dns zone | + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + description: 云账号Id, 仅在zone_type为PublicZone时生效, 若为空则不会在云上创建 + type: string + x-go-name: CloudaccountId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + options: + description: 额外信息 + type: object + x-go-name: Options + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_ids: + description: VPC id列表, 仅在zone_type为PrivateZone时生效, vpc列表必须属于同一个账号 + items: + type: string + type: array + x-go-name: VpcIds + zone_type: + description: |- + 区域类型 + + + 类型 | 说明 | + ---------- |---------| + PublicZone | 公有 | + PrivateZone | 私有 | + type: string + x-go-name: ZoneType + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_caches: + description: Cache info + items: + type: object + type: array + x-go-name: CloudCaches + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + dns_recordset_count: + description: Dns记录数量 + format: int64 + type: integer + x-go-name: DnsRecordsetCount + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + id: + description: 资源UUID + type: string + x-go-name: Id + is_dirty: + type: boolean + x-go-name: IsDirty + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + options: + type: object + x-go-name: Options + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc_count: + description: 关联vpc数量 + format: int64 + type: integer + x-go-name: VpcCount + zone_type: + type: string + x-go-name: ZoneType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZonePurgeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneRemoveVpcsInput: + properties: + vpc_ids: + description: VPC id列表 + items: + type: string + type: array + x-go-name: VpcIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneSyncRecordSetsInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneSyncStatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DnsZoneUnacheInput: + properties: + CloudaccountId: + description: 云账号Id + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + DomainLevelResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + DynamicschedtagDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + condition: + description: 动态调度标间的匹配条件 + example: host.sys_load > 1.5 || host.mem_used_percent > 0.7 => "high_load" + type: string + x-go-name: Condition + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + enabled: + type: boolean + x-go-name: Enabled + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + resource_type: + description: 调度标签管理的资源类型 + type: string + x-go-name: ResourceType + schedtag: + description: 调度标签名称 + type: string + x-go-name: Schedtag + schedtag_id: + description: 归属调度标签ID + type: string + x-go-name: SchedtagId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticDissociateInput: + properties: + auto_delete: + default: false + description: |- + 注意: 若关联到aws NAT网关后，目前没办法解除关联关系 + 是否解绑后自动删除弹性公网IP + type: boolean + x-go-name: AutoDelete + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticSearchAccessInfo: + description: +onecloud:model-api-gen + properties: + Domain: + type: string + KibanaPrivateUrl: + type: string + KibanaUrl: + type: string + Port: + format: int64 + type: integer + PrivateDomain: + type: string + PrivatePort: + format: int64 + type: integer + Vip: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + ElasticSearchCreateInput: + description: 资源创建参数, 目前仅占位 + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticSearchDetails: + description: 资源返回详情 + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network: + description: IP子网名称 + type: string + x-go-name: Network + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheAccountDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + account_privilege: + description: 账号类型 normal |admin + type: string + x-go-name: AccountPrivilege + account_type: + type: string + x-go-name: AccountType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + engine: + description: 引擎 + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + password: + description: 账号权限 read | write | repl（复制, 复制权限支持读写，且开放SYNC/PSYNC命令） + type: string + x-go-name: Password + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属Zone ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheAclDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + engine: + description: 引擎 + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ip_list: + description: Ip地址白名单列表 + type: string + x-go-name: IpList + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属Zone ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheBackupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + backup_mode: + description: 备份模式，自动|手动 + type: string + x-go-name: BackupMode + backup_size_mb: + description: 备份大小 + format: int64 + type: integer + x-go-name: BackupSizeMb + backup_type: + description: 备份类型, 全量|增量额 + type: string + x-go-name: BackupType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + download_url: + description: 下载地址 + type: string + x-go-name: DownloadURL + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + end_time: + description: 结束备份时间 + format: date-time + type: string + x-go-name: EndTime + engine: + description: 引擎 + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + start_time: + description: 开始备份时间 + format: date-time + type: string + x-go-name: StartTime + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属Zone ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + BillingType: + description: 计费方式 + enum: + - postpaid + - ' prepaid' + type: string + auto_renew: + default: false + description: 是否自动续费(仅包年包月时生效) + type: boolean + x-go-name: AutoRenew + capacity_mb: + format: int64 + type: integer + x-go-name: CapacityMb + cloudregion_id: + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时间周期 + type: string + x-go-name: Duration + engine: + description: 弹性缓存Engine + enum: + - redis + - ' memcached' + type: string + x-go-name: Engine + engine_version: + description: 弹性缓存Engine版本 + type: string + x-go-name: EngineVersion + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + instance_type: + description: 实例规格 + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + local_category: + type: string + x-go-name: LocalCategory + maintain_start_time: + description: |- + 弹性缓存维护时间段 + 华为云此参数可选,其它云该参数无效 + enum: + - "22:00:00" + - ' 02:00:00' + - ' 06:00:00' + - ' 10:00:00' + - ' 14:00:00' + - ' 18:00:00' + type: string + x-go-name: MaintainStartTime + memory_size_mb: + description: 'swagger: ignore' + format: int64 + type: integer + x-go-name: MemorySizeMb + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network: + description: 'swagger: ignore' + type: string + x-go-name: Network + network_id: + description: Ip子网名称或Id,建议使用Id + type: string + x-go-name: NetworkId + network_type: + description: 网络类型 + enum: + - vpc + - ' cLassic' + type: string + x-go-name: NetworkType + node_type: + type: string + x-go-name: NodeType + password: + description: 初始密码 + type: string + x-go-name: Password + private_ip: + description: |- + 内网IP + 阿里云、华为云此参数可选，其它公有云该参数无效 + type: string + x-go-name: PrivateIp + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + reset_password: + type: boolean + x-go-name: ResetPassword + secgroup_ids: + default: default + description: 安全组名称或Id + items: + type: string + type: array + x-go-name: SecgroupIds + slave_zones: + description: |- + 备可用区名称或Id列表, split by: , + 默认副本与主可用区一致 + 支持此参数的云厂商: 腾讯云 + type: string + x-go-name: SlaveZones + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + zone: + description: 'swagger: ignore' + type: string + x-go-name: Zone + zone_id: + description: 主可用区名称或Id + type: string + x-go-name: ZoneId + required: + - name + - network_id + - network_type + - engine + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + auth_mode: + description: 访问密码？ on （开启密码）|off （免密码访问） + type: string + x-go-name: AuthMode + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + bandwidth: + description: 带宽 + format: int64 + type: integer + x-go-name: Bandwidth + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capacity_mb: + description: 容量 + example: 1024 + format: int64 + type: integer + x-go-name: CapacityMB + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + connections: + description: 最大连接数 + format: int64 + type: integer + x-go-name: Connections + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + domain_id: + description: 域Id + type: string + x-go-name: DomainId + engine: + description: |- + 后端存储引擎 + Redis | Memcache + example: redis + type: string + x-go-name: Engine + engine_version: + description: 后端存储引擎版本 + example: "4.0" + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 实例规格 + example: redis.master.micro.default + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + local_category: + description: 对应Sku + type: string + x-go-name: LocalCategory + maintain_end_time: + description: 维护结束时间 + type: string + x-go-name: MaintainEndTime + maintain_start_time: + description: 维护开始时间，格式为HH:mmZ + example: 02:00Z + type: string + x-go-name: MaintainStartTime + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + description: 所属网络ID + type: string + x-go-name: NetworkId + network_type: + description: 网络类型, CLASSIC（经典网络） VPC（专有网络） + example: CLASSIC + type: string + x-go-name: NetworkType + node_type: + description: |- + 类型 + single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | readfive（5只读） + type: string + x-go-name: NodeType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + private_connect_port: + description: 内网访问端口 + format: int64 + type: integer + x-go-name: PrivateConnectPort + private_dns: + description: 内网DNS + type: string + x-go-name: PrivateDNS + private_ip_addr: + description: 内网IP地址 + type: string + x-go-name: PrivateIpAddr + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_connect_port: + description: 外网访问端口 + format: int64 + type: integer + x-go-name: PublicConnectPort + public_dns: + description: 公网DNS + type: string + x-go-name: PublicDNS + public_ip_addr: + description: 公网IP地址 + type: string + x-go-name: PublicIpAddr + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secgroups: + description: 关联安全组列表 + items: + $ref: '#/definitions/StandaloneShortDesc' + type: array + x-go-name: Secgroups + slave_zone_infos: + description: 备可用区列表 + items: + $ref: '#/definitions/StandaloneShortDesc' + type: array + x-go-name: SlaveZoneInfos + slave_zones: + description: 备可用区 + type: string + x-go-name: SlaveZones + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheJointBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheParameterDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + engine: + description: 引擎 + type: string + x-go-name: Engine + engine_version: + description: 引擎版本 + type: string + x-go-name: EngineVersion + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + force_restart: + description: True（重启生效） False（无需重启，提交后即生效） + type: boolean + x-go-name: ForceRestart + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + key: + description: Parameter KEY + type: string + x-go-name: Key + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + modifiable: + description: True（可修改） False（不可修改） + type: boolean + x-go-name: Modifiable + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + value: + description: Parameter Value + type: string + x-go-name: Value + value_range: + description: 校验代码，参数的可选范围。 + type: string + x-go-name: ValueRange + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属Zone ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheSecgroupsInput: + properties: + secgroup_ids: + description: |- + 安全组Id列表 + 实例必须处于运行状态 + + + 平台 | 最多绑定安全组数量 | + -------------|------------------- | + 腾讯云 | 10 | + 华为云 | 不支持安全组 | + 阿里云 | 不支持安全组 | + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheSkuDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + cpu_arch: + description: CPU 架构 x86|ARM + type: string + x-go-name: CpuArch + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disk_size_gb: + description: 套餐附带硬盘容量 + format: int64 + type: integer + x-go-name: DiskSizeGB + engine: + description: "引擎\tredis|memcached" + type: string + x-go-name: Engine + engine_arch: + type: string + x-go-name: EngineArch + engine_version: + description: "引擎版本\t3.0" + type: string + x-go-name: EngineVersion + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_spec: + type: string + x-go-name: InstanceSpec + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + local_category: + type: string + x-go-name: LocalCategory + max_clients: + description: 最大客户端数 + format: int64 + type: integer + x-go-name: MaxClients + max_connections: + description: 最大连接数 + format: int64 + type: integer + x-go-name: MaxConnections + max_in_bandwidth_mb: + description: 最大内网带宽 + format: int64 + type: integer + x-go-name: MaxInBandwidthMb + max_memory_mb: + description: 实际可使用的最大内存 + format: int64 + type: integer + x-go-name: MaxMemoryMB + max_replicas_num: + description: 最大副本数量 + format: int64 + type: integer + x-go-name: MaxReplicasNum + max_shard_num: + description: 最大分片数量 + format: int64 + type: integer + x-go-name: MaxShardNum + memory_size_mb: + description: 内存容量 + format: int64 + type: integer + x-go-name: MemorySizeMB + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + node_type: + description: single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | + readfive（5只读） + type: string + x-go-name: NodeType + performance_type: + description: standrad|enhanced + type: string + x-go-name: PerformanceType + postpaid_status: + type: string + x-go-name: PostpaidStatus + prepaid_status: + type: string + x-go-name: PrepaidStatus + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: "公有云厂商\tAliyun/Azure/AWS/Qcloud/..." + type: string + x-go-name: Provider + qps: + description: QPS参考值 + format: int64 + type: integer + x-go-name: QPS + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + replicas_num: + description: 最小副本数量 + format: int64 + type: integer + x-go-name: ReplicasNum + shard_num: + description: 最小分片数量 + format: int64 + type: integer + x-go-name: ShardNum + slave_zone: + description: 可用区名称 + example: 北京2区 + type: string + x-go-name: SlaveZone + slave_zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: SlaveZoneExtId + slave_zone_id: + type: string + x-go-name: SlaveZoneId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + description: "存储类型\tDRAM|SCM" + type: string + x-go-name: StorageType + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcacheSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticcachesecgroupDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + elasticcache: + description: 弹性缓存实例名称 + type: string + x-go-name: Elasticcache + elasticcache_id: + description: 弹性缓存ID + type: string + x-go-name: ElasticcacheId + row_id: + format: int64 + type: integer + x-go-name: RowId + secgroup: + description: 安全组名称 + type: string + x-go-name: Secgroup + secgroup_id: + description: 本地安全组ID + type: string + x-go-name: SecgroupId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticipAssociateInput: + properties: + instance_id: + description: 待绑定实例Id + type: string + x-go-name: InstanceId + instance_type: + default: server + description: |- + 实例类型 + enmu: server, natgateway + type: string + x-go-name: InstanceType + ip_addr: + description: EIP映射的内网IP地址，可选 + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticipDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + associate_id: + description: 绑定资源Id + type: string + x-go-name: AssociateId + associate_name: + description: 绑定资源名称 + type: string + x-go-name: AssociateName + associate_type: + description: 绑定资源类型 + type: string + x-go-name: AssociateType + auto_dellocate: + description: 是否跟随主机删除而自动释放 + type: boolean + x-go-name: AutoDellocate + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + bandwidth: + description: 带宽大小 + format: int64 + type: integer + x-go-name: Bandwidth + bgp_type: + description: 线路类型 + type: string + x-go-name: BgpType + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + charge_type: + description: '计费类型: 流量、带宽' + example: bandwidth + type: string + x-go-name: ChargeType + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mode: + description: |- + 标识弹性或非弹性 + Mode | 说明 | + ------------|------------| + public_ip | 公网IP | + elastic_ip | 弹性公网IP | + example: elastic_ip + type: string + x-go-name: Mode + name: + description: 资源名称 + type: string + x-go-name: Name + network_id: + description: IP子网Id, 仅私有云不为空 + type: string + x-go-name: NetworkId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ElasticipSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + EnabledStatusInfrasResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + EnabledStatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + EnabledStatusStandaloneResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + ExternalProjectChangeProjectInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ExternalProjectCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudaccount_id: + type: string + x-go-name: CloudaccountId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + manager_id: + type: string + x-go-name: ManagerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ExternalProjectDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudaccount_id: + description: 归属云账号ID + type: string + x-go-name: CloudaccountId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + environment: + description: Environment + type: string + x-go-name: Environment + external_domain_id: + type: string + x-go-name: ExternalDomainId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + FileSystemCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + auto_renew: + default: false + description: 是否自动续费(仅包年包月时生效) + type: boolean + x-go-name: AutoRenew + billing_type: + description: 计费方式 + enum: + - postpaid + - ' prepaid' + type: string + x-go-name: BillingType + capacity: + description: 容量大小 + format: int64 + type: integer + x-go-name: Capacity + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时间周期 + type: string + x-go-name: Duration + expired_at: + description: 到期释放时间，仅后付费支持 + format: date-time + type: string + x-go-name: ExpiredAt + file_system_type: + description: |- + 文件系统类型 + enmu: extreme, standard, cpfs + type: string + x-go-name: FileSystemType + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager_id: + description: 订阅Id, 若传入network_id此参数可忽略 + type: string + x-go-name: ManagerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_id: + description: IP子网Id + type: string + x-go-name: NetworkId + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + protocol: + description: 协议类型 + enum: + - NFS + - ' SMB' + - ' CPFS' + type: string + x-go-name: Protocol + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_type: + description: |- + 存储类型 + enmu: performance, capacity, standard, advance, advance_100, advance_200 + type: string + x-go-name: StorageType + zone_id: + description: 可用区Id, 若不指定IP子网，此参数必填 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + FileSystemDetails: + properties: + Network: + type: string + Vpc: + type: string + Zone: + type: string + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + FileSystemRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + FileSystemSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + Floppy: + properties: + detail: + type: string + x-go-name: Detail + ordinal: + format: int64 + type: integer + x-go-name: Ordinal + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GetCloudaccountSamlOutput: + properties: + entity_id: + description: cloudaccount SAML ServiceProvider entity ID + type: string + x-go-name: EntityId + init_login_url: + description: initial SAML SSO login URL for this cloudaccount + type: string + x-go-name: InitLoginUrl + metadata_url: + description: metadata URL for this cloudaccount + type: string + x-go-name: MetadataUrl + redirect_login_url: + description: redirect login URL for this cloudaccount + type: string + x-go-name: RedirectLoginUrl + redirect_logout_url: + description: redirect logout URL for this cloudaccount + type: string + x-go-name: RedirectLogoutUrl + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + GetNetworkAddressesOutput: + properties: + addresses: + description: IP子网地址记录 + items: + $ref: '#/definitions/SNetworkUsedAddress' + type: array + x-go-name: Addresses + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GlobalVpcCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GlobalVpcDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc_count: + description: vpc数量 + format: int64 + type: integer + x-go-name: VpcCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GlobalvpcUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GroupAttachNetworkInput: + properties: + alloc_dir: + $ref: '#/definitions/IPAllocationDirection' + ip_addr: + description: candidate IPaddr + type: string + x-go-name: IpAddr + network_id: + description: network id or name + type: string + x-go-name: NetworkId + require_designated_ip: + description: Required Designed IP + type: boolean + x-go-name: RequireDesignatedIp + reserved: + description: Reserved + type: boolean + x-go-name: Reserved + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GroupDetachNetworkInput: + properties: + ip_addr: + description: candidate IPaddr + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GroupguestDetails: + properties: + Guest: + type: string + Server: + type: string + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + group_id: + type: string + x-go-name: GroupId + guest_id: + type: string + x-go-name: GuestId + guest_status: + type: string + x-go-name: GuestStatus + instance_group: + description: 主机组的名称 + type: string + x-go-name: Instancegroup + row_id: + format: int64 + type: integer + x-go-name: RowId + tag: + type: string + x-go-name: Tag + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GroupnetworkDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + eip_addr: + description: EipAddr if eip is associated with this groupnetwork + type: string + x-go-name: EipAddr + eip_id: + type: string + x-go-name: EipId + group_id: + type: string + x-go-name: GroupId + index: + format: uint8 + type: integer + x-go-name: Index + instance_group: + description: 主机组的名称 + type: string + x-go-name: Instancegroup + ip_addr: + type: string + x-go-name: IpAddr + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + row_id: + format: int64 + type: integer + x-go-name: RowId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestAddSecgroupInput: + properties: + secgroup_ids: + description: |- + 安全组Id列表 + 实例必须处于运行,休眠或者关机状态 + + + 平台 | 最多绑定安全组数量 | + -------------|------------------- | + Azure | 1 | + VMware | 不支持安全组 | + Baremetal | 不支持安全组 | + ZStack | 1 | + 其他 | 5 | + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestAssignSecgroupInput: + properties: + secgroup_id: + description: |- + 安全组Id + 实例必须处于运行,休眠或者关机状态 + type: string + x-go-name: SecgroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestAutoRenewInput: + properties: + auto_renew: + default: false + description: 设置自动续费 + type: boolean + x-go-name: AutoRenew + duration: + default: 1M + description: 续费周期 + example: 1Y, 1M, 1W + type: string + x-go-name: Duration + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestDiskDetails: + properties: + Disk: + description: 磁盘名称 + type: string + aio_mode: + description: Column(VARCHAR(32, charset='ascii'), nullable=True) + type: string + x-go-name: AioMode + boot_index: + description: Column(TINYINT(4), nullable=False, default=0) + format: uint8 + type: integer + x-go-name: BootIndex + bps: + format: int64 + type: integer + x-go-name: Bps + cache_mode: + description: Column(VARCHAR(32, charset='ascii'), nullable=True) + type: string + x-go-name: CacheMode + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + disk_id: + type: string + x-go-name: DiskId + disk_size: + description: 磁盘大小, 单位Mb + example: 10240 + format: int64 + type: integer + x-go-name: DiskSize + disk_type: + description: 磁盘类型 + example: data + type: string + x-go-name: DiskType + driver: + type: string + x-go-name: Driver + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + type: string + x-go-name: GuestId + image_path: + type: string + x-go-name: ImagePath + index: + format: uint8 + type: integer + x-go-name: Index + iops: + description: Column(VARCHAR(32, charset='ascii'), nullable=True) + format: int64 + type: integer + x-go-name: Iops + medium_type: + description: 介质类型 + example: ssd + type: string + x-go-name: MediumType + mountpoint: + type: string + x-go-name: Mountpoint + row_id: + format: int64 + type: integer + x-go-name: RowId + server: + description: 云主机名称 + type: string + x-go-name: Server + status: + description: 磁盘状态 + example: ready + type: string + x-go-name: Status + storage_type: + description: 存储类型 + example: local + type: string + x-go-name: StorageType + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestDiskInfo: + properties: + aio_mode: + type: string + x-go-name: AioMode + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + bps: + format: int64 + type: integer + x-go-name: Bps + cache_mode: + type: string + x-go-name: CacheMode + disk_format: + type: string + x-go-name: DiskFormat + disk_type: + type: string + x-go-name: DiskType + driver: + type: string + x-go-name: Driver + fs: + type: string + x-go-name: FsFormat + id: + type: string + x-go-name: Id + image: + type: string + x-go-name: Image + image_id: + type: string + x-go-name: ImageId + index: + format: int8 + type: integer + x-go-name: Index + iops: + format: int64 + type: integer + x-go-name: Iops + medium_type: + type: string + x-go-name: MediumType + name: + type: string + x-go-name: Name + size: + format: int64 + type: integer + x-go-name: SizeMb + storage_id: + type: string + x-go-name: StorageId + storage_type: + type: string + x-go-name: StorageType + title: GuestDiskInfo describe the information of disk on the guest. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestHaveAgentInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestHaveAgentOutput: + properties: + Have: + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestJointBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestJointResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + guest: + description: 云主机名称 + type: string + x-go-name: Guest + server: + description: 云主机名称 + type: string + x-go-name: Server + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestLiveMigrateInput: + properties: + enable_tls: + description: 是否启用 tls + type: boolean + x-go-name: EnableTLS + keep_dest_guest_on_failed: + type: boolean + x-go-name: KeepDestGuestOnFailed + max_bandwidth_mb: + description: 迁移带宽限制 + format: int64 + type: integer + x-go-name: MaxBandwidthMb + prefer_host: + description: 'swagger: ignore' + type: string + x-go-name: PreferHost + prefer_host_id: + description: 指定期望的迁移目标宿主机 + type: string + x-go-name: PreferHostId + quickly_finish: + description: 快速完成，内存同步一定周期后调整 downtime + type: boolean + x-go-name: QuicklyFinish + skip_cpu_check: + description: 是否跳过CPU检查，默认要做CPU检查 + type: boolean + x-go-name: SkipCpuCheck + skip_kernel_check: + description: 是否跳过kernel检查 + type: boolean + x-go-name: SkipKernelCheck + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestMakeSshableCmdOutput: + properties: + ShellCmd: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestMakeSshableInput: + properties: + Password: + type: string + Port: + format: int64 + type: integer + PrivateKey: + type: string + User: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestMakeSshableOutput: + properties: + AnsiblePlaybookId: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestMigrateInput: + properties: + auto_start: + type: boolean + x-go-name: AutoStart + prefer_host: + description: 'swagger: ignore' + type: string + x-go-name: PreferHost + prefer_host_id: + type: string + x-go-name: PreferHostId + rescue_mode: + type: boolean + x-go-name: IsRescueMode + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestPublicipToEipInput: + properties: + auto_start: + default: false + description: 转换完成后是否自动启动 + type: boolean + x-go-name: AutoStart + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestRevokeSecgroupInput: + properties: + secgroup_ids: + description: |- + 安全组Id列表 + 实例必须处于运行,休眠或者关机状态 + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSaveToTemplateInput: + properties: + generate_name: + description: The generate name of guest template + type: string + x-go-name: GenerateName + name: + description: The name of guest template + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSetSecgroupInput: + properties: + secgroup_ids: + description: |- + 安全组Id列表 + 实例必须处于运行,休眠或者关机状态 + + + 平台 | 最多绑定安全组数量 | + -------------|------------------- | + Azure | 1 | + VMware | 不支持安全组 | + Baremetal | 不支持安全组 | + ZStack | 1 | + 其他 | 5 | + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSetSshportInput: + properties: + Port: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSshportOutput: + properties: + Port: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestSyncFixNicsInput: + properties: + ip: + description: 需要修正的IP地址列表 + items: + type: string + type: array + x-go-name: Ip + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateConfigInfo: + properties: + disks: + items: + $ref: '#/definitions/GuestTemplateDisk' + type: array + x-go-name: Disks + image: + type: string + x-go-name: Image + isolated_device_config: + items: + $ref: '#/definitions/IsolatedDeviceConfig' + type: array + x-go-name: IsolatedDeviceConfig + keypair: + type: string + x-go-name: Keypair + metadata: + additionalProperties: + type: string + type: object + x-go-name: Metadata + nets: + items: + $ref: '#/definitions/GuestTemplateNetwork' + type: array + x-go-name: Nets + reset_password: + type: boolean + x-go-name: ResetPassword + secgroup: + type: string + x-go-name: Secgroup + sku: + $ref: '#/definitions/GuestTemplateSku' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + billing_type: + type: string + x-go-name: BillingType + cloudregion_id: + type: string + x-go-name: CloudregionId + content: + description: 'description: the content of guest template' + type: object + x-go-name: Content + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + hypervisor: + type: string + x-go-name: Hypervisor + image_id: + type: string + x-go-name: ImageId + image_type: + type: string + x-go-name: ImageType + instance_type: + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + os_type: + type: string + x-go-name: OsType + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vcpu_count: + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size: + format: int64 + type: integer + x-go-name: VmemSize + vpc_id: + type: string + x-go-name: VpcId + required: + - name + - content + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + billing_type: + description: 计费方式 + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + config_info: + $ref: '#/definitions/GuestTemplateConfigInfo' + content: + description: 其他配置信息 + type: object + x-go-name: Content + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + environment: + description: Environment + type: string + x-go-name: Environment + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + hypervisor: + description: 虚拟机技术 + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + image_id: + description: 镜像ID + type: string + x-go-name: ImageId + image_type: + description: 镜像类型 + type: string + x-go-name: ImageType + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + os_type: + description: 虚拟机操作系统类型 + pattern: Linux|Windows|VMWare + type: string + x-go-name: OsType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secgroups: + items: + type: string + type: array + x-go-name: Secgroups + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vcpu_count: + description: 虚拟机CPU数量 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size: + description: 虚拟机内存大小（MB） + format: int64 + type: integer + x-go-name: VmemSize + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + zone: + type: string + x-go-name: Zone + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateDisk: + properties: + backend: + type: string + x-go-name: Backend + disk_type: + type: string + x-go-name: DiskType + index: + format: int64 + type: integer + x-go-name: Index + size_mb: + format: int64 + type: integer + x-go-name: SizeMb + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateNetwork: + properties: + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_start: + type: string + x-go-name: GuestIpStart + id: + type: string + x-go-name: ID + name: + type: string + x-go-name: Name + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + vpc_id: + type: string + x-go-name: VpcId + vpc_name: + type: string + x-go-name: VpcName + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateSku: + properties: + cpu_core_count: + format: int64 + type: integer + x-go-name: CpuCoreCount + instance_type_category: + type: string + x-go-name: InstanceTypeCategory + instance_type_family: + type: string + x-go-name: InstanceTypeFamily + memory_size_mb: + format: int64 + type: integer + x-go-name: MemorySizeMb + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestTemplateUpdateInput: + properties: + billing_type: + type: string + x-go-name: BillingType + cloudregion_id: + type: string + x-go-name: CloudregionId + content: + description: 'description: the content of guest template' + type: object + x-go-name: Content + description: + description: 资源描述 + type: string + x-go-name: Description + hypervisor: + type: string + x-go-name: Hypervisor + image_id: + type: string + x-go-name: ImageId + image_type: + type: string + x-go-name: ImageType + instance_type: + type: string + x-go-name: InstanceType + name: + description: 资源名称 + type: string + x-go-name: Name + os_type: + type: string + x-go-name: OsType + progress: + format: float + type: number + x-go-name: Progress + vcpu_count: + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size: + format: int64 + type: integer + x-go-name: VmemSize + vpc_id: + type: string + x-go-name: VpcId + required: + - content + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestdiskUpdateInput: + properties: + aio_mode: + type: string + x-go-name: AioMode + bps: + format: int64 + type: integer + x-go-name: Bps + cache_mode: + type: string + x-go-name: CacheMode + driver: + type: string + x-go-name: Driver + index: + format: int8 + type: integer + x-go-name: Index + iops: + format: int64 + type: integer + x-go-name: Iops + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestnetworkDetails: + properties: + bw_limit: + description: 带宽限制，单位mbps + format: int64 + type: integer + x-go-name: BwLimit + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + driver: + description: 虚拟网卡驱动 + type: string + x-go-name: Driver + eip_addr: + description: EipAddr associate with this guestnetwork + type: string + x-go-name: EipAddr + eip_id: + description: 网卡关联的Eip实例 + type: string + x-go-name: EipId + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + type: string + x-go-name: GuestId + ifname: + description: 虚拟网卡设备名称 + type: string + x-go-name: Ifname + index: + description: 网卡序号 + format: uint8 + type: integer + x-go-name: Index + ip_addr: + description: IPv4地址 + type: string + x-go-name: IpAddr + ip6_addr: + description: IPv6地址 + type: string + x-go-name: Ip6Addr + mac_addr: + description: MAC地址 + type: string + x-go-name: MacAddr + mapped_ip_addr: + description: IPv4映射地址，当子网属于私有云vpc的时候分配，用于访问外网 + type: string + x-go-name: MappedIpAddr + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + num_queues: + description: 网卡队列数 + format: int64 + type: integer + x-go-name: NumQueues + row_id: + format: int64 + type: integer + x-go-name: RowId + server: + description: 云主机名称 + type: string + x-go-name: Server + team_with: + description: bind配对网卡MAC地址 + type: string + x-go-name: TeamWith + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + virtual: + description: 是否为虚拟接口（无IP） + type: boolean + x-go-name: Virtual + wire_id: + description: 所属Wire + type: string + x-go-name: WireId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestnetworkShortDesc: + properties: + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + ip6_addr: + description: IPv6地址 + type: string + x-go-name: Ip6Addr + is_exit: + description: |- + 是否为外网网卡 + Deprecated + type: boolean + x-go-name: IsExit + mac: + description: Mac地址 + type: string + x-go-name: Mac + network_id: + description: 所属Network + type: string + x-go-name: NetworkId + team_with: + description: Bonding的配对网卡MAC + type: string + x-go-name: TeamWith + vpc_id: + description: 所属Vpc + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestnetworkUpdateInput: + properties: + bw_limit: + format: int64 + type: integer + x-go-name: BwLimit + driver: + type: string + x-go-name: Driver + index: + format: int8 + type: integer + x-go-name: Index + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + GuestsecgroupDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + type: string + x-go-name: GuestId + row_id: + format: int64 + type: integer + x-go-name: RowId + secgroup: + description: 安全组名称 + type: string + x-go-name: Secgroup + secgroup_id: + description: 本地安全组ID + type: string + x-go-name: SecgroupId + server: + description: 云主机名称 + type: string + x-go-name: Server + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + Header: + additionalProperties: + items: + type: string + type: array + description: |- + The keys should be in canonical form, as returned by + CanonicalHeaderKey. + title: A Header represents the key-value pairs in an HTTP header. + type: object + x-go-package: net/http + Host: + description: Host represents an ansible host + properties: + Name: + description: Name denotes the host to operate on + type: string + Vars: + additionalProperties: + type: string + description: Vars is a map recording host vars + type: object + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/ansible + HostAutoMigrateInput: + properties: + auto_migrate_on_host_down: + type: string + x-go-name: AutoMigrateOnHostDown + auto_migrate_on_host_shutdown: + type: string + x-go-name: AutoMigrateOnHostShutdown + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + access_ip: + description: 物理机管理口IP + type: string + x-go-name: AccessIp + access_mac: + description: 物理机管理口MAC + type: string + x-go-name: AccessMac + access_net: + description: 物理机管理口IP子网 + type: string + x-go-name: AccessNet + access_wire: + description: 物理机管理口二次网络 + type: string + x-go-name: AccessWire + boot_mode: + description: 主机启动模式, 可能值位PXE和ISO + type: string + x-go-name: BootMode + cpu_architecture: + description: CPU架构 + type: string + x-go-name: CpuArchitecture + cpu_cache: + description: CPU缓存大小,单位KB + type: string + x-go-name: CpuCache + cpu_cmtbound: + description: CPU超分比 + format: float + type: number + x-go-name: CpuCmtbound + cpu_count: + description: CPU核数 + format: int64 + type: integer + x-go-name: CpuCount + cpu_desc: + description: CPU描述信息 + type: string + x-go-name: CpuDesc + cpu_mhz: + description: CPU频率 + format: int64 + type: integer + x-go-name: CpuMhz + cpu_microcode: + description: CPUMicrocode + type: string + x-go-name: CpuMicrocode + cpu_reserved: + description: 预留CPU大小 + format: int64 + type: integer + x-go-name: CpuReserved + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enable_pxe_boot: + description: 是否允许PXE启动 + type: boolean + x-go-name: EnablePxeBoot + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + host_type: + description: Host类型 + type: string + x-go-name: HostType + hostname: + description: |- + 主机名 + 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 + 字符长度2-60个字符 + Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 + 若输入为空，则会根据资源名称自动生成主机名 + 输入不为空则会自动剔除不符合规则的字符, 并进行校验 + 若长度大于允许的最大长度，会自动截取 + type: string + x-go-name: Hostname + ipmi_cdrom_boot: + description: Cdrom boot support + type: boolean + x-go-name: IpmiCdromBoot + ipmi_ip_addr: + description: ip address + type: string + x-go-name: IpmiIpAddr + ipmi_lan_channel: + description: lan channel + format: int64 + type: integer + x-go-name: IpmiLanChannel + ipmi_password: + description: password + type: string + x-go-name: IpmiPassword + ipmi_present: + description: presence + type: boolean + x-go-name: IpmiPresent + ipmi_pxe_boot: + description: ipmi_pxe_boot + type: boolean + x-go-name: IpmiPxeBoot + ipmi_redfish_api: + description: Redfish API support + type: boolean + x-go-name: IpmiRedfishApi + ipmi_username: + description: username + type: string + x-go-name: IpmiUsername + ipmi_verified: + description: verified + type: boolean + x-go-name: IpmiVerified + is_baremetal: + description: 是否为裸金属 + type: boolean + x-go-name: IsBaremetal + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_import: + description: 是否为导入的宿主机 + type: boolean + x-go-name: IsImport + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager_uri: + description: 物理机管理URI + type: string + x-go-name: ManagerUri + mem_cmtbound: + description: 内存超分比 + format: float + type: number + x-go-name: MemCmtbound + mem_reserved: + description: 预留内存大小(单位MB) + type: string + x-go-name: MemReserved + mem_size: + description: 内存大小(单位MB) + type: string + x-go-name: MemSize + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + no_bmc: + description: 物理机不带 BMC 控制器 + type: boolean + x-go-name: NoBMC + no_probe: + description: 新建带IPMI信息的物理机时不进行IPMI信息探测 + type: boolean + x-go-name: NoProbe + node_count: + description: 物理CPU颗数 + format: int8 + type: integer + x-go-name: NodeCount + ovn_version: + description: OVN软件版本 + type: string + x-go-name: OvnVersion + page_size_kb: + description: 页大小 + format: int64 + type: integer + x-go-name: PageSizeKB + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + rack: + description: 机架 + type: string + x-go-name: Rack + slots: + description: 机位 + type: string + x-go-name: Slots + sn: + description: 物理机序列号信息 + type: string + x-go-name: SN + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_driver: + description: 存储驱动类型 + type: string + x-go-name: StorageDriver + storage_info: + description: 存储详情 + type: object + x-go-name: StorageInfo + storage_size: + description: 存储大小,单位Mb + format: int64 + type: integer + x-go-name: StorageSize + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + sys_info: + description: 系统信息 + type: object + x-go-name: SysInfo + uuid: + description: host uuid + type: string + x-go-name: Uuid + version: + description: host服务软件版本 + type: string + x-go-name: Version + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostDetails: + properties: + IsolatedDeviceCount: + description: isolated device count + format: int64 + type: integer + access_ip: + description: 管理口Ip地址 + type: string + x-go-name: AccessIp + access_mac: + description: 管理口MAC + type: string + x-go-name: AccessMac + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + actual_storage_used: + description: 实际已使用存储大小 + format: int64 + type: integer + x-go-name: ActualStorageUsed + allow_health_check: + description: 允许开启宿主机健康检查 + type: boolean + x-go-name: AllowHealthCheck + auto_migrate_on_host_down: + type: boolean + x-go-name: AutoMigrateOnHostDown + auto_migrate_on_host_shutdown: + type: boolean + x-go-name: AutoMigrateOnHostShutdown + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + boot_mode: + description: 主机启动模式, 可能值为PXE和ISO + type: string + x-go-name: BootMode + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_prepare: + type: boolean + x-go-name: CanPrepare + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + cpu_architecture: + description: CPU架构 + type: string + x-go-name: CpuArchitecture + cpu_cache: + description: CPU缓存大小,单位KB + format: int64 + type: integer + x-go-name: CpuCache + cpu_cmtbound: + description: CPU超分比 + format: float + type: number + x-go-name: CpuCmtbound + cpu_commit: + description: CPU超分比 + format: int64 + type: integer + x-go-name: CpuCommit + cpu_commit_bound: + description: CPU超售比 + format: float + type: number + x-go-name: CpuCommitBound + cpu_commit_rate: + description: CPU超分率 + format: double + type: number + x-go-name: CpuCommitRate + cpu_count: + description: CPU核数 + format: int64 + type: integer + x-go-name: CpuCount + cpu_desc: + description: CPU描述信息 + type: string + x-go-name: CpuDesc + cpu_mhz: + description: CPU频率 + format: int64 + type: integer + x-go-name: CpuMhz + cpu_microcode: + description: CPUMicrocode + type: string + x-go-name: CpuMicrocode + cpu_reserved: + description: 预留CPU大小 + format: int64 + type: integer + x-go-name: CpuReserved + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enable_health_check: + description: health check enabled by host agent online + type: boolean + x-go-name: EnableHealthCheck + enable_pxe_boot: + description: 是否允许PXE启动 + type: boolean + x-go-name: EnablePxeBoot + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + guests: + description: 云主机数量 + example: 10 + format: int64 + type: integer + x-go-name: Guests + host_status: + description: 宿主机状态 + example: online + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + hostname: + type: string + x-go-name: Hostname + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ipmi_info: + description: IPMI详情 + type: object + x-go-name: IpmiInfo + ipmi_ip: + description: IPMI地址 + type: string + x-go-name: IpmiIp + is_baremetal: + type: boolean + x-go-name: IsBaremetal + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_import: + description: 是否为导入的宿主机 + type: boolean + x-go-name: IsImport + is_maintenance: + description: 是否处于维护状态 + type: boolean + x-go-name: IsMaintenance + is_prepaid_recycle: + type: boolean + x-go-name: IsPrepaidRecycle + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + manager_uri: + description: 管理地址 + type: string + x-go-name: ManagerUri + mem_cmtbound: + description: 内存超分比 + format: float + type: number + x-go-name: MemCmtbound + mem_commit: + description: 内存超分比 + format: int64 + type: integer + x-go-name: MemCommit + mem_commit_bound: + description: 内存超售比 + format: float + type: number + x-go-name: MemCommitBound + mem_commit_rate: + description: 内存超分率 + format: double + type: number + x-go-name: MemCommitRate + mem_reserved: + description: 预留内存大小 + format: int64 + type: integer + x-go-name: MemReserved + mem_size: + description: 内存大小,单位Mb + format: int64 + type: integer + x-go-name: MemSize + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nic_count: + description: 网卡数量 + format: int64 + type: integer + x-go-name: NicCount + nic_info: + description: 网卡详情 + items: + type: object + type: array + x-go-name: NicInfo + node_count: + description: 物理CPU颗数 + format: uint8 + type: integer + x-go-name: NodeCount + nonsystem_guests: + description: 非系统云主机数量 + example: 0 + format: int64 + type: integer + x-go-name: NonsystemGuests + other_guests: + description: 其他状态云主机数量 + example: 2 + format: int64 + type: integer + x-go-name: OtherGuests + ovn_mapped_ip_addr: + description: IPv4地址，作为私有云vpc访问外网时的网关 + type: string + x-go-name: OvnMappedIpAddr + ovn_version: + description: OVN软件版本 + type: string + x-go-name: OvnVersion + page_size_kb: + description: 页大小 + format: int64 + type: integer + x-go-name: PageSizeKB + pending_deleted_guests: + description: 回收站中云主机数量 + example: 2 + format: int64 + type: integer + x-go-name: PendingDeletedGuests + prepare_fail_reason: + type: string + x-go-name: PrepareFailReason + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + rack: + description: 机架 + type: string + x-go-name: Rack + ready_guests: + description: 关机状态云主机数量 + example: 2 + format: int64 + type: integer + x-go-name: ReadyGuests + real_external_id: + type: string + x-go-name: RealExternalId + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + reserved_resource_for_gpu: + $ref: '#/definitions/IsolatedDeviceReservedResourceInput' + resource_type: + type: string + x-go-name: ResourceType + running_guests: + description: 运行状态云主机数量 + example: 2 + format: int64 + type: integer + x-go-name: RunningGuests + schedtags: + items: + $ref: '#/definitions/SchedtagShortDescDetails' + type: array + x-go-name: Schedtags + server: + type: string + x-go-name: Server + server_id: + type: string + x-go-name: ServerId + server_ips: + type: string + x-go-name: ServerIps + server_pending_deleted: + type: boolean + x-go-name: ServerPendingDeleted + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + slots: + description: 机位 + type: string + x-go-name: Slots + sn: + description: 物理机序列号信息 + type: string + x-go-name: SN + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + spec: + type: object + x-go-name: Spec + status: + description: 资源状态 + type: string + x-go-name: Status + storage: + description: 存储大小 + format: int64 + type: integer + x-go-name: Storage + storage_commit_rate: + description: 存储超分率 + format: double + type: number + x-go-name: StorageCommitRate + storage_driver: + description: 存储驱动类型 + type: string + x-go-name: StorageDriver + storage_free: + description: 可用存储大小 + format: int64 + type: integer + x-go-name: StorageFree + storage_info: + description: 存储详情 + type: object + x-go-name: StorageInfo + storage_size: + description: 存储大小,单位Mb + format: int64 + type: integer + x-go-name: StorageSize + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + storage_used: + description: 已使用存储大小 + format: int64 + type: integer + x-go-name: StorageUsed + storage_virtual: + description: 虚拟存储大小 + format: int64 + type: integer + x-go-name: StorageVirtual + storage_waste: + description: 浪费存储大小(异常磁盘存储大小) + format: int64 + type: integer + x-go-name: StorageWaste + sys_error: + description: host init error info + type: string + x-go-name: SysError + sys_info: + description: 系统信息 + type: object + x-go-name: SysInfo + sys_warn: + description: host init warnning + type: string + x-go-name: SysWarn + uefi_info: + description: UEFI详情 + type: object + x-go-name: UefiInfo + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + uuid: + description: 主机UUID + type: string + x-go-name: Uuid + version: + description: host服务软件版本 + type: string + x-go-name: Version + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostOfflineInput: + properties: + Reason: + type: string + update_health_status: + type: boolean + x-go-name: UpdateHealthStatus + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostReserveCpusInput: + properties: + Cpus: + type: string + Mems: + type: string + disable_sched_load_balance: + type: boolean + x-go-name: DisableSchedLoadBalance + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostStorageCreateInput: + properties: + host_id: + type: string + x-go-name: HostId + mount_point: + type: string + x-go-name: MountPoint + storage_id: + type: string + x-go-name: StorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostTopologyOutput: + properties: + host_status: + type: string + x-go-name: HostStatus + host_type: + type: string + x-go-name: HostType + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + networks: + items: + $ref: '#/definitions/HostnetworkTopologyOutput' + type: array + x-go-name: Networks + schedtags: + items: + $ref: '#/definitions/SchedtagShortDescDetails' + type: array + x-go-name: Schedtags + status: + type: string + x-go-name: Status + storages: + items: + $ref: '#/definitions/StorageShortDesc' + type: array + x-go-name: Storages + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostUpdateInput: + properties: + access_ip: + description: 物理机管理口IP + type: string + x-go-name: AccessIp + access_mac: + description: 物理机管理口MAC + type: string + x-go-name: AccessMac + access_net: + description: 物理机管理口IP子网 + type: string + x-go-name: AccessNet + access_wire: + description: 物理机管理口二次网络 + type: string + x-go-name: AccessWire + boot_mode: + description: 主机启动模式, 可能值位PXE和ISO + type: string + x-go-name: BootMode + cpu_architecture: + description: CPU架构 + type: string + x-go-name: CpuArchitecture + cpu_cache: + description: CPU缓存大小,单位KB + type: string + x-go-name: CpuCache + cpu_cmtbound: + description: CPU超分比 + format: float + type: number + x-go-name: CpuCmtbound + cpu_count: + description: CPU核数 + format: int64 + type: integer + x-go-name: CpuCount + cpu_desc: + description: CPU描述信息 + type: string + x-go-name: CpuDesc + cpu_mhz: + description: CPU频率 + format: int64 + type: integer + x-go-name: CpuMhz + cpu_microcode: + description: CPUMicrocode + type: string + x-go-name: CpuMicrocode + cpu_reserved: + description: 预留CPU大小 + format: int64 + type: integer + x-go-name: CpuReserved + description: + description: 资源描述 + type: string + x-go-name: Description + enable_pxe_boot: + description: 是否允许PXE启动 + type: boolean + x-go-name: EnablePxeBoot + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + hostname: + description: |- + 主机名 + 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 + 字符长度2-60个字符 + Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 + 若输入为空，则会根据资源名称自动生成主机名 + 输入不为空则会自动剔除不符合规则的字符, 并进行校验 + 若长度大于允许的最大长度，会自动截取 + type: string + x-go-name: Hostname + ipmi_cdrom_boot: + description: Cdrom boot support + type: boolean + x-go-name: IpmiCdromBoot + ipmi_info: + description: IPMI info + type: object + x-go-name: IpmiInfo + ipmi_ip_addr: + description: ip address + type: string + x-go-name: IpmiIpAddr + ipmi_lan_channel: + description: lan channel + format: int64 + type: integer + x-go-name: IpmiLanChannel + ipmi_password: + description: password + type: string + x-go-name: IpmiPassword + ipmi_present: + description: presence + type: boolean + x-go-name: IpmiPresent + ipmi_pxe_boot: + description: ipmi_pxe_boot + type: boolean + x-go-name: IpmiPxeBoot + ipmi_redfish_api: + description: Redfish API support + type: boolean + x-go-name: IpmiRedfishApi + ipmi_username: + description: username + type: string + x-go-name: IpmiUsername + ipmi_verified: + description: verified + type: boolean + x-go-name: IpmiVerified + is_baremetal: + description: 是否为裸金属 + type: boolean + x-go-name: IsBaremetal + manager_uri: + description: 物理机管理URI + type: string + x-go-name: ManagerUri + mem_cmtbound: + description: 内存超分比 + format: float + type: number + x-go-name: MemCmtbound + mem_reserved: + description: 预留内存大小(单位MB) + type: string + x-go-name: MemReserved + mem_size: + description: 内存大小(单位MB) + type: string + x-go-name: MemSize + name: + description: 资源名称 + type: string + x-go-name: Name + node_count: + description: 物理CPU颗数 + format: int8 + type: integer + x-go-name: NodeCount + ovn_version: + description: OVN软件版本 + type: string + x-go-name: OvnVersion + page_size_kb: + description: 页大小 + format: int64 + type: integer + x-go-name: PageSizeKB + rack: + description: 机架 + type: string + x-go-name: Rack + slots: + description: 机位 + type: string + x-go-name: Slots + sn: + description: 物理机序列号信息 + type: string + x-go-name: SN + storage_driver: + description: 存储驱动类型 + type: string + x-go-name: StorageDriver + storage_info: + description: 存储详情 + type: object + x-go-name: StorageInfo + storage_size: + description: 存储大小,单位Mb + format: int64 + type: integer + x-go-name: StorageSize + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + sys_info: + description: 系统信息 + type: object + x-go-name: SysInfo + uuid: + description: 主机UUID + type: string + x-go-name: Uuid + version: + description: host服务软件版本 + type: string + x-go-name: Version + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostnetworkDetails: + properties: + baremetal: + description: |- + 裸金属服务器名称 + Deprecated + type: string + x-go-name: Baremetal + baremetal_id: + description: 宿主机ID + type: string + x-go-name: BaremetalId + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + host: + description: 宿主机名称 + type: string + x-go-name: Host + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + mac_addr: + description: MAC地址 + type: string + x-go-name: MacAddr + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + description: 网络ID + type: string + x-go-name: NetworkId + nic_type: + type: string + x-go-name: NicType + row_id: + format: int64 + type: integer + x-go-name: RowId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + wire: + description: 二层网络名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostnetworkTopologyOutput: + properties: + ip_addr: + type: string + x-go-name: IpAddr + mac_addr: + type: string + x-go-name: MacAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HoststorageDetails: + properties: + baremetal: + description: |- + 裸金属服务器名称 + Deprecated + type: string + x-go-name: Baremetal + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capacity: + description: 存储大小 + format: int64 + type: integer + x-go-name: Capacity + cmtbound: + description: 超售比 + format: float + type: number + x-go-name: Cmtbound + config: + description: 配置信息 + type: object + x-go-name: Config + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + enabled: + description: 是否启用 + type: boolean + x-go-name: Enabled + free_capacity: + description: 可用存储大小 + format: int64 + type: integer + x-go-name: FreeCapacity + guest_disk_count: + format: int64 + type: integer + x-go-name: GuestDiskCount + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_id: + description: 宿主机Id + type: string + x-go-name: HostId + imagecache_path: + description: 镜像缓存路径 + type: string + x-go-name: ImagecachePath + is_root_partition: + description: 是否是根分区 + type: boolean + x-go-name: IsRootPartition + medium_type: + description: 介质类型 + example: ssd + type: string + x-go-name: MediumType + mount_point: + description: |- + 挂载点 + nvme pci address + type: string + x-go-name: MountPoint + real_capacity: + description: 真实容量大小 + format: int64 + type: integer + x-go-name: RealCapacity + row_id: + format: int64 + type: integer + x-go-name: RowId + storage: + description: 存储名称 + type: string + x-go-name: Storage + storage_conf: + description: 存储配置信息 + type: object + x-go-name: StorageConf + storage_id: + description: 存储Id + type: string + x-go-name: StorageId + storage_type: + description: 存储类型 + example: local + type: string + x-go-name: StorageType + storagecache_id: + description: 存储缓存Id + type: string + x-go-name: StoragecacheId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_capacity: + description: 已使用存储大小 + format: int64 + type: integer + x-go-name: UsedCapacity + waste_capacity: + description: 浪费存储大小(异常磁盘总大小) + format: int64 + type: integer + x-go-name: WasteCapacity + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + HostwireDetails: + properties: + bandwidth: + description: 带宽大小 + format: int64 + type: integer + x-go-name: Bandwidth + baremetal: + description: |- + 裸金属服务器名称 + Deprecated + type: string + x-go-name: Baremetal + bridge: + type: string + x-go-name: Bridge + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_id: + description: 宿主机Id + type: string + x-go-name: HostId + interface: + description: 接口名称 + type: string + x-go-name: Interface + is_master: + description: 是否是主地址 + type: boolean + x-go-name: IsMaster + mac_addr: + description: MAC地址 + type: string + x-go-name: MacAddr + row_id: + format: int64 + type: integer + x-go-name: RowId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + wire: + description: 二层网络名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络Id + type: string + x-go-name: WireId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IPAllocationDirection: + type: string + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IPv6GatewayCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IPv6GatewayDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IPv6GatewayUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IdNameDetails: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + InstanceBackupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + backup_storage_name: + description: 存储类型 + type: string + x-go-name: BackupStorageName + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + delete_fail_reason: + $ref: '#/definitions/Error' + disk_backups: + description: 硬盘备份详情 + items: + $ref: '#/definitions/SSimpleBackup' + type: array + x-go-name: DiskBackups + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_status: + description: 云主机状态 + type: string + x-go-name: GuestStatus + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + size: + description: 主机快照大小 + format: int64 + type: integer + x-go-name: Size + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceBackupManagerCreateFromPackageInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + BackupStorageId: + type: string + PackageName: + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceBackupManagerSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceBackupPackInput: + properties: + PackageName: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceBackupRecoveryInput: + properties: + Name: + description: 'description: name of guest' + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceGroupDetail: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + force_dispersion: + type: boolean + x-go-name: ForceDispersion + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + granularity: + description: the upper limit number of guests with this group in a host + format: int64 + type: integer + x-go-name: Granularity + guest_count: + description: 云主机数量 + format: int64 + type: integer + x-go-name: GuestCount + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: Attached Network + type: string + x-go-name: Network + network_id: + description: Attached NetworkId + type: string + x-go-name: NetworkId + parent_id: + type: string + x-go-name: ParentId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + sched_strategy: + description: 调度策略 + type: string + x-go-name: SchedStrategy + service_type: + description: 服务类型 + type: string + x-go-name: ServiceType + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vip_eip: + description: EIP of VIP + type: string + x-go-name: VipEip + vips: + description: VIP + items: + type: string + type: array + x-go-name: Vips + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InstanceSnapshotDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + auto_delete: + description: 是否自动删除 + type: boolean + x-go-name: AutoDelete + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + description: 云主机Id + type: string + x-go-name: GuestId + guest_status: + description: 云主机状态 + type: string + x-go-name: GuestStatus + id: + description: 资源UUID + type: string + x-go-name: Id + image_id: + description: 镜像ID + type: string + x-go-name: ImageId + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + keypair_id: + description: 秘钥Id + type: string + x-go-name: KeypairId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + memory_file_checksum: + description: 内存文件校验和 + type: string + x-go-name: MemoryFileChecksum + memory_file_host_id: + description: 内存文件所在宿主机 + type: string + x-go-name: MemoryFileHostId + memory_file_path: + description: 内存文件路径 + type: string + x-go-name: MemoryFilePath + memory_size_mb: + description: 内存文件大小 + format: int64 + type: integer + x-go-name: MemorySizeMB + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + os_type: + description: 操作系统类型 + type: string + x-go-name: OsType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + properties: + additionalProperties: + type: string + type: object + x-go-name: Properties + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + ref_count: + description: 引用次数 + format: int64 + type: integer + x-go-name: RefCount + sec_groups: + description: 安全组 + type: object + x-go-name: SecGroups + server_config: + description: 云主机配置 + type: object + x-go-name: ServerConfig + server_metadata: + description: 云主机标签 + type: object + x-go-name: ServerMetadata + size: + description: 主机快照大小 + format: int64 + type: integer + x-go-name: Size + size_mb: + description: 主机快照磁盘容量和 + format: int64 + type: integer + x-go-name: SizeMb + snapshots: + description: 快照列表 + items: + $ref: '#/definitions/SimpleSnapshot' + type: array + x-go-name: Snapshots + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + with_memory: + description: 是否保存内存 + type: boolean + x-go-name: WithMemory + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkAddVpcInput: + properties: + vpc_id: + description: |- + 待加入的vpc id + vpc和当前vpc互联所必须是同一平台，且运营平台一致，例如aws中国区不能和aws国际区运营平台不一致 + 可以通过 /vpcs?usable_for_inter_vpc_network_id=<当前vpc互联id> 过滤可以加入的vpc列表 + type: string + x-go-name: VpcId + required: + - vpc_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager_id: + type: string + x-go-name: ManagerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + vpc_count: + format: int64 + type: integer + x-go-name: VpcCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkRemoveVpcInput: + properties: + VpcId: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkRouteSetDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkRouteSetDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkRouteSetEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + InterVpcNetworkSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolateDeviceDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + addr: + description: '# pci address of `Bus:Device.Function` format, or usb bus address + of `bus.addr`' + type: string + x-go-name: Addr + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + dev_type: + description: |- + # PCI / GPU-HPC / GPU-VGA / USB / NIC + 设备类型 + type: string + x-go-name: DevType + disk_index: + description: guest disk index + format: uint8 + type: integer + x-go-name: DiskIndex + environment: + description: Environment + type: string + x-go-name: Environment + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + description: 云主机Id + type: string + x-go-name: GuestId + guest_status: + description: 云主机状态 + type: string + x-go-name: GuestStatus + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_enabled: + description: 宿主是否启用 + type: boolean + x-go-name: HostEnabled + host_id: + type: string + x-go-name: HostId + host_service_status: + description: 宿主机服务状态` + type: string + x-go-name: HostServiceStatus + host_sn: + description: 宿主机序列号 + type: string + x-go-name: HostSN + host_status: + description: 宿主机状态 + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + model: + description: '# Specific device name read from lspci command, e.g. `Tesla + K40m` ...' + type: string + x-go-name: Model + name: + description: 资源名称 + type: string + x-go-name: Name + network_index: + description: guest network index + format: uint8 + type: integer + x-go-name: NetworkIndex + nvme_size_mb: + description: NVME disk size + format: int64 + type: integer + x-go-name: NvmeSizeMB + ovs_offload_interface: + description: Offload interface name + type: string + x-go-name: OvsOffloadInterface + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + reserved_cpu: + description: reserved cpu count for isolated device + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: reserved memory size for isolated device + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: reserved storage size for isolated device + format: int64 + type: integer + x-go-name: ReservedStorage + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vendor_device_id: + type: string + x-go-name: VendorDeviceId + wire_id: + description: Nic wire id + type: string + x-go-name: WireId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceConfig: + properties: + dev_type: + type: string + x-go-name: DevType + disk_index: + format: int8 + type: integer + x-go-name: DiskIndex + id: + type: string + x-go-name: Id + index: + format: int64 + type: integer + x-go-name: Index + model: + type: string + x-go-name: Model + network_index: + format: int8 + type: integer + x-go-name: NetworkIndex + vendor: + type: string + x-go-name: Vendor + wire_id: + type: string + x-go-name: WireId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + addr: + description: |- + PCI地址 + # pci address of `Bus:Device.Function` format, or usb bus address of `bus.addr` + type: string + x-go-name: Addr + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dev_type: + description: 设备类型USB/GPU + example: GPU + type: string + x-go-name: DevType + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + host_id: + description: 宿主机或物理机（ID或Name） + type: string + x-go-name: HostId + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + model: + description: |- + 设备型号 + # Specific device name read from lspci command, e.g. `Tesla K40m` ... + type: string + x-go-name: Model + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + reserved_cpu: + description: GPU 预留CPU + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: GPU 预留内存 + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: GPU 预留磁盘 + format: int64 + type: integer + x-go-name: ReservedStorage + vendor_device_id: + description: 设备VendorId + type: string + x-go-name: VendorDeviceId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceModelCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dev_type: + description: 设备类型 + example: NPU + type: string + x-go-name: DevType + device_id: + description: 设备DeviceId + type: string + x-go-name: DeviceId + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + hosts: + description: hosts scan isolated device after isolated_device_model created + items: + type: string + type: array + x-go-name: Hosts + hot_pluggable: + description: 支持热插拔 HotPluggable + type: boolean + x-go-name: HotPluggable + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + model: + description: 设备型号 + type: string + x-go-name: Model + vendor_id: + description: 设备VendorId + type: string + x-go-name: VendorId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceModelUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + dev_type: + description: 设备类型 + example: NPU + type: string + x-go-name: DevType + device_id: + description: 设备DeviceId + type: string + x-go-name: DeviceId + hot_pluggable: + description: 支持热插拔 HotPluggable + type: boolean + x-go-name: HotPluggable + model: + description: 设备型号 + type: string + x-go-name: Model + vendor_id: + description: 设备VendorId + type: string + x-go-name: VendorId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceReservedResourceInput: + properties: + reserved_cpu: + description: GPU 预留CPU + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: GPU 预留内存 + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: GPU 预留磁盘 + format: int64 + type: integer + x-go-name: ReservedStorage + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + IsolatedDeviceUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + dev_type: + type: string + x-go-name: DevType + name: + description: 资源名称 + type: string + x-go-name: Name + reserved_cpu: + description: GPU 预留CPU + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: GPU 预留内存 + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: GPU 预留磁盘 + format: int64 + type: integer + x-go-name: ReservedStorage + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + JoinResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + KafkaCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KafkaDetails: + description: 资源返回详情 + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network: + description: IP子网名称 + type: string + x-go-name: Network + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KeypairCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + owner_id: + description: 本地用户Id，若为空则使用当前用户Id作为此参数值 + type: string + x-go-name: OwnerId + public_key: + description: 公钥内容,若为空则自动生成公钥 + type: string + x-go-name: PublicKey + scheme: + default: RSA + description: 秘钥类型 + enum: + - RSA + type: string + x-go-name: Scheme + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KeypairDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + fingerprint: + description: 指纹信息 + example: 1d:3a:83:4a:a1:f3:75:97:ec:d1:ef:f8:3f:a7:5d:9e + type: string + x-go-name: Fingerprint + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + linked_guest_count: + description: 关联云主机次数 + format: int64 + type: integer + x-go-name: LinkedGuestCount + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + owner_id: + description: 本地用户Id + type: string + x-go-name: OwnerId + owner_name: + description: 用户名称 + type: string + x-go-name: OwnerName + private_key: + description: 私钥 + type: string + x-go-name: PrivateKey + private_key_len: + description: 私钥长度 + format: int64 + type: integer + x-go-name: PrivateKeyLen + public_key: + description: 公钥 + type: string + x-go-name: PublicKey + scheme: + description: 加密类型 + example: RSA + type: string + x-go-name: Scheme + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeClusterCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_ids: + $ref: '#/definitions/SKubeNetworkIds' + private_access: + type: boolean + x-go-name: PrivateAccess + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_access: + type: boolean + x-go-name: PublicAccess + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + role_name: + type: string + x-go-name: RoleName + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + version: + type: string + x-go-name: Version + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + required: + - name + - network_ids + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeClusterDeleteInput: + properties: + retain: + default: false + description: 是否保留集群关联的实例及slb + type: boolean + x-go-name: Retain + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeClusterDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_cluster_id: + description: 本地KubeserverId + type: string + x-go-name: ExternalClusterId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network_ids: + $ref: '#/definitions/SKubeNetworkIds' + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + version: + type: string + x-go-name: Version + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeClusterUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodeCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodeDetails: + properties: + DomainId: + type: string + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodePoolCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloud_kube_cluster_id: + type: string + x-go-name: CloudKubeClusterId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + desired_instance_count: + default: 2 + description: 预期节点数量, 不得小于min_instance_count + format: int64 + type: integer + x-go-name: DesiredInstanceCount + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + instance_types: + $ref: '#/definitions/SInstanceTypes' + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + keypair_id: + description: 秘钥id，若不传，则使用系统级秘钥 + type: string + x-go-name: KeypairId + max_instance_count: + default: 2 + format: int64 + type: integer + x-go-name: MaxInstanceCount + min_instance_count: + default: 2 + format: int64 + type: integer + x-go-name: MinInstanceCount + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_ids: + $ref: '#/definitions/SKubeNetworkIds' + public_key: + description: 'swagger: ignore' + type: string + x-go-name: PublicKey + root_disk_size_gb: + format: int64 + type: integer + x-go-name: RootDiskSizeGb + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodePoolDetails: + properties: + DomainId: + type: string + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodePoolUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + KubeNodeUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAclCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Fingerprint: + description: 'swagger: ignore' + type: string + acl_entries: + $ref: '#/definitions/SAclEntries' + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAclDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + acl_entries: + $ref: '#/definitions/SAclEntries' + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + fingerprint: + type: string + x-go-name: Fingerprint + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_dirty: + description: 是否变化 + type: boolean + x-go-name: IsDirty + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + lb_listener_count: + format: int64 + type: integer + x-go-name: LbListenerCount + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAclPatchInput: + properties: + adds: + items: + $ref: '#/definitions/SAclEntry' + type: array + x-go-name: Adds + dels: + items: + $ref: '#/definitions/SAclEntry' + type: array + x-go-name: Dels + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAclUpdateInput: + properties: + Fingerprint: + description: 'swagger: ignore' + type: string + acl_entries: + $ref: '#/definitions/SAclEntries' + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAgentDeployInput: + properties: + DeployMethod: + type: string + Host: + $ref: '#/definitions/Host' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAgentDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + cluster: + description: 负载均衡集群名称 + type: string + x-go-name: Cluster + cluster_id: + description: 归属LB集群 + type: string + x-go-name: ClusterId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + deployment: + $ref: '#/definitions/SLoadbalancerAgentDeployment' + description: + description: 资源描述信息 + type: string + x-go-name: Description + ha_state: + type: string + x-go-name: HaState + hb_last_seen: + description: LB_HA_STATE_UNKNOWN + format: date-time + type: string + x-go-name: HbLastSeen + hb_timeout: + format: int64 + type: integer + x-go-name: HbTimeout + id: + description: 资源UUID + type: string + x-go-name: Id + interface: + type: string + x-go-name: Interface + ip: + type: string + x-go-name: IP + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + loadbalancer_acls: + format: date-time + type: string + x-go-name: LoadbalancerAcls + loadbalancer_backend_groups: + format: date-time + type: string + x-go-name: LoadbalancerBackendGroups + loadbalancer_backends: + format: date-time + type: string + x-go-name: LoadbalancerBackends + loadbalancer_certificates: + format: date-time + type: string + x-go-name: LoadbalancerCertificates + loadbalancer_listener_rules: + format: date-time + type: string + x-go-name: LoadbalancerListenerRules + loadbalancer_listeners: + format: date-time + type: string + x-go-name: LoadbalancerListeners + loadbalancer_networks: + format: date-time + type: string + x-go-name: LoadbalancerNetworks + loadbalancers: + format: date-time + type: string + x-go-name: Loadbalancers + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + format: date-time + type: string + x-go-name: Networks + params: + $ref: '#/definitions/SLoadbalancerAgentParams' + priority: + format: int64 + type: integer + x-go-name: Priority + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + version: + type: string + x-go-name: Version + vpc: + description: VPC名称 + type: string + x-go-name: Vpc + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAgentJoinClusterInput: + properties: + cluster_id: + type: string + x-go-name: ClusterId + priority: + format: int64 + type: integer + x-go-name: Priority + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAgentLeaveClusterInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerAssociateEipInput: + properties: + eip_id: + description: 弹性公网IP的ID + type: string + x-go-name: EipId + ip_addr: + description: 弹性IP映射的内网IP地址，可选 + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + address: + type: string + x-go-name: Address + backend: + description: 'swagger: ignore' + type: string + x-go-name: Backend + backend_group: + description: 'swagger: ignore' + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + backend_id: + type: string + x-go-name: BackendId + backend_type: + type: string + x-go-name: BackendType + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + port: + format: int64 + type: integer + x-go-name: Port + send_proxy: + type: string + x-go-name: SendProxy + ssl: + type: string + x-go-name: Ssl + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + weight: + format: int64 + type: integer + x-go-name: Weight + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + address: + type: string + x-go-name: Address + backend_group: + description: 负载均衡后端组名称 + type: string + x-go-name: BackendGroup + backend_group_id: + description: 负载均衡后端组ID + type: string + x-go-name: BackendGroupId + backend_id: + type: string + x-go-name: BackendId + backend_role: + type: string + x-go-name: BackendRole + backend_type: + type: string + x-go-name: BackendType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + port: + format: int64 + type: integer + x-go-name: Port + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + send_proxy: + type: string + x-go-name: SendProxy + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + ssl: + type: string + x-go-name: Ssl + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + weight: + format: int64 + type: integer + x-go-name: Weight + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendGroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + backends: + items: + properties: + Address: + type: string + BackendRole: + type: string + BackendType: + type: string + ExternalId: + type: string + HostName: + type: string + Id: + type: string + Index: + format: int64 + type: integer + Name: + type: string + Port: + format: int64 + type: integer + Weight: + format: int64 + type: integer + ZoneId: + type: string + type: object + type: array + x-go-name: Backends + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + loadbalancer: + description: 'swagger: ignore' + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendGroupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + lb_listener_count: + format: int64 + type: integer + x-go-name: LbListenerCount + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + type: string + x-go-name: ProjectId + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerBackendUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + port: + format: int64 + type: integer + x-go-name: Port + progress: + format: float + type: number + x-go-name: Progress + send_proxy: + type: string + x-go-name: SendPorxy + ssl: + type: string + x-go-name: Ssl + weight: + format: int64 + type: integer + x-go-name: Weight + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCertificateCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + certificate: + type: string + x-go-name: Certificate + common_name: + description: 'swagger: ignore' + type: string + x-go-name: CommonName + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + fingerprint: + description: 'swagger: ignore' + type: string + x-go-name: Fingerprint + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + not_after: + description: 'swagger: ignore' + format: date-time + type: string + x-go-name: NotAfter + not_before: + description: 'swagger: ignore' + format: date-time + type: string + x-go-name: NotBefore + private_key: + type: string + x-go-name: PrivateKey + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_key_algorithm: + description: 'swagger: ignore' + type: string + x-go-name: PublicKeyAlgorithm + public_key_bit_len: + description: 'swagger: ignore' + format: int64 + type: integer + x-go-name: PublicKeyBitLen + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + signature_algorithm: + description: 'swagger: ignore' + type: string + x-go-name: SignatureAlgorithm + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + subject_alternative_names: + description: 'swagger: ignore' + type: string + x-go-name: SubjectAlternativeNames + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCertificateDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + certificate: + type: string + x-go-name: Certificate + common_name: + type: string + x-go-name: CommonName + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + fingerprint: + type: string + x-go-name: Fingerprint + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_complete: + description: 证书内容是否完整 + type: boolean + x-go-name: IsComplete + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + lb_listener_count: + format: int64 + type: integer + x-go-name: LbListenerCount + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + not_after: + format: date-time + type: string + x-go-name: NotAfter + not_before: + format: date-time + type: string + x-go-name: NotBefore + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + private_key: + type: string + x-go-name: PrivateKey + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + public_key_algorithm: + description: derived attributes + type: string + x-go-name: PublicKeyAlgorithm + public_key_bit_len: + format: int64 + type: integer + x-go-name: PublicKeyBitLen + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + signature_algorithm: + type: string + x-go-name: SignatureAlgorithm + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + subject_alternative_names: + type: string + x-go-name: SubjectAlternativeNames + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCertificateUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerClusterDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + params: + $ref: '#/definitions/SLoadbalancerClusterParams' + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCreateEipInput: + properties: + auto_dellocate: + description: auto_dellocate + type: boolean + x-go-name: AutoDellocate + bandwidth: + description: Bandwidth + format: int64 + type: integer + x-go-name: Bandwidth + bgp_type: + description: bgp_type + type: string + x-go-name: BgpType + charge_type: + description: 计费方式，traffic or bandwidth + type: string + x-go-name: ChargeType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Networks: + description: |- + 多子网 + swagger: ignore + items: + type: string + type: array + address: + description: IP地址 + type: string + x-go-name: Address + address_type: + description: 地址类型 + type: string + x-go-name: AddressType + charge_type: + description: 计费类型 + type: string + x-go-name: ChargeType + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + cluster_id: + description: 负载均衡集群Id + type: string + x-go-name: ClusterId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时长 + type: string + x-go-name: Duration + egress_mbps: + description: 出口带宽 + format: int64 + type: integer + x-go-name: EgressMbps + eip: + description: 'swagger: ignore' + type: string + x-go-name: Eip + eip_auto_dellocate: + description: 是否跟随主机删除而自动释放 + type: boolean + x-go-name: EipAutoDellocate + eip_bgp_type: + description: 弹性公网IP线路类型 + type: string + x-go-name: EipBgpType + eip_bw: + description: |- + 弹性公网IP带宽 + 指定此参数后会创建新的弹性公网IP并绑定到新建的负载均衡 + format: int64 + type: integer + x-go-name: EipBw + eip_charge_type: + description: 弹性公网IP计费类型 + type: string + x-go-name: EipChargeType + eip_id: + description: EIP Id + type: string + x-go-name: EipId + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + lb_info: + description: LB的其他配置信息 + type: object + x-go-name: LBInfo + loadbalancer_spec: + description: 套餐名称 + type: string + x-go-name: LoadbalancerSpec + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_id: + description: IP子网（ID或Name） + type: string + x-go-name: NetworkId + network_type: + description: 网络类型 + type: string + x-go-name: NetworkType + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + zone_1: + description: 从可用区1 + type: string + x-go-name: Zone1 + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + address: + description: IP地址 + type: string + x-go-name: Address + address_type: + description: 地址类型 + type: string + x-go-name: AddressType + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backend_group: + description: 后端服务器组名称 + type: string + x-go-name: BackendGroup + backend_group_id: + description: 默认后端服务器组Id + type: string + x-go-name: BackendGroupId + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + charge_type: + description: 计费类型 + type: string + x-go-name: ChargeType + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + cluster: + description: 负载均衡集群名称 + type: string + x-go-name: Cluster + cluster_id: + description: 归属LB集群 + type: string + x-go-name: ClusterId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + domain_id: + description: 域Id + type: string + x-go-name: DomainId + egress_mbps: + format: int64 + type: integer + x-go-name: EgressMbps + eip: + description: 公网IP地址 + type: string + x-go-name: Eip + eip_id: + type: string + x-go-name: EipId + eip_mode: + description: '公网IP地址类型: 弹性、非弹性' + example: public_ip + type: string + x-go-name: EipMode + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + lb_info: + description: LB的其他配置信息 + type: object + x-go-name: LBInfo + loadbalancer_spec: + description: 套餐名称 + type: string + x-go-name: LoadbalancerSpec + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + network_type: + description: 网络类型 + type: string + x-go-name: NetworkType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_1: + description: 备可用区 + type: string + x-go-name: Zone1 + zone_1_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: Zone1ExtId + zone_1_name: + description: 可用区名称 + example: 北京2区 + type: string + x-go-name: Zone1Name + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerDissociateEipInput: + properties: + auto_delete: + description: 是否自动释放 + type: boolean + x-go-name: AudoDelete + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + acl: + description: 'swagger: ignore' + type: string + x-go-name: Acl + acl_id: + type: string + x-go-name: AclId + acl_status: + type: string + x-go-name: AclStatus + acl_type: + type: string + x-go-name: AclType + backend_connect_timeout: + default: 5 + description: range 1-180 + format: int64 + type: integer + x-go-name: BackendConnectTimeout + backend_group: + description: 'swagger: ignore' + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + backend_idle_timeout: + default: 90 + description: range 1-600 + format: int64 + type: integer + x-go-name: BackendIdleTimeout + certificate: + description: 'swagger: ignore' + type: string + x-go-name: Certificate + certificate_id: + type: string + x-go-name: CertificateId + client_idle_timeout: + default: 90 + description: range 1-600 + format: int64 + type: integer + x-go-name: ClientIdleTimeout + client_request_timeout: + default: 10 + description: range 1-600 + format: int64 + type: integer + x-go-name: ClientReqeustTimeout + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + egress_mbps: + format: int64 + type: integer + x-go-name: EgressMbps + enable_http2: + default: true + type: boolean + x-go-name: EnableHttp2 + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + gzip: + type: boolean + x-go-name: Gzip + health_check: + default: "on" + type: string + x-go-name: HealthCheck + health_check_fail: + default: 2 + description: 2-10 + format: int64 + type: integer + x-go-name: HealthCheckFail + health_check_http_code: + default: http_2xx,http_3xx + type: string + x-go-name: HealthCheckHttpCode + health_check_interval: + default: 30 + description: 5-300 + format: int64 + type: integer + x-go-name: HealthCheckInterval + health_check_path: + type: string + x-go-name: HealthCheckPath + health_check_rise: + default: 5 + description: 2-10 + format: int64 + type: integer + x-go-name: HealthCheckRise + health_check_timeout: + default: 5 + description: 2-120 + format: int64 + type: integer + x-go-name: HealthCheckTimeout + health_check_type: + enum: + - tcp + - ' udp' + - ' http' + type: string + x-go-name: HealthCheckType + http_request_rate: + format: int64 + type: integer + x-go-name: HttpRequestRate + http_request_rate_src: + format: int64 + type: integer + x-go-name: HttpRequestRatePerSrc + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + listener_port: + format: int64 + type: integer + x-go-name: ListenerPort + listener_type: + type: string + x-go-name: ListenerType + loadbalancer: + description: 'swagger: ignore' + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + redirect: + default: "off" + type: string + x-go-name: Redirect + redirect_code: + format: int64 + type: integer + x-go-name: RedirectCode + redirect_host: + type: string + x-go-name: RedirectHost + redirect_path: + type: string + x-go-name: RedirectPath + redirect_scheme: + type: string + x-go-name: RedirectScheme + scheduler: + type: string + x-go-name: Scheduler + send_proxy: + type: string + x-go-name: SendProxy + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + sticky_session: + type: string + x-go-name: StickySession + sticky_session_cookie: + type: string + x-go-name: StickySessionCookie + sticky_session_cookie_timeout: + format: int64 + type: integer + x-go-name: StickySessionCookieTimeout + sticky_session_type: + type: string + x-go-name: StickySessionType + string: + type: string + x-go-name: HealthCheckDomain + tls_cipher_policy: + type: string + x-go-name: TLSCipherPolicy + x_forwarded_for: + default: true + type: boolean + x-go-name: XForwardedFor + required: + - name + - listener_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + acl: + description: 负载均衡ACL名称 + type: string + x-go-name: Acl + acl_id: + description: 本地Acl ID + type: string + x-go-name: AclId + acl_status: + type: string + x-go-name: AclStatus + acl_type: + type: string + x-go-name: AclType + backend_connect_timeout: + description: 连接空闲超时时间 + format: int64 + type: integer + x-go-name: BackendConnectTimeout + backend_group: + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + backend_idle_timeout: + description: 后端连接超时时间 + format: int64 + type: integer + x-go-name: BackendIdleTimeout + backend_server_port: + format: int64 + type: integer + x-go-name: BackendServerPort + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + certificate: + description: 负载均衡证书名称 + type: string + x-go-name: Certificate + certificate_id: + description: 本地负载均衡证书ID + type: string + x-go-name: CertificateId + certificate_name: + type: string + x-go-name: CertificateName + client_idle_timeout: + description: 连接请求超时时间 + format: int64 + type: integer + x-go-name: ClientIdleTimeout + client_request_timeout: + format: int64 + type: integer + x-go-name: ClientRequestTimeout + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + egress_mbps: + format: int64 + type: integer + x-go-name: EgressMbps + enable_http2: + type: boolean + x-go-name: EnableHttp2 + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + gzip: + description: 获取客户端真实IP + type: boolean + x-go-name: Gzip + health_check: + type: string + x-go-name: HealthCheck + health_check_domain: + type: string + x-go-name: HealthCheckDomain + health_check_exp: + description: UDP监听健康检查的请求串 + type: string + x-go-name: HealthCheckExp + health_check_fall: + description: 健康检查健康阈值 3秒 + format: int64 + type: integer + x-go-name: HealthCheckFall + health_check_http_code: + description: 健康检查路径 / + type: string + x-go-name: HealthCheckHttpCode + health_check_interval: + description: 健康检查超时时间 10秒 + format: int64 + type: integer + x-go-name: HealthCheckInterval + health_check_req: + type: string + x-go-name: HealthCheckReq + health_check_rise: + format: int64 + type: integer + x-go-name: HealthCheckRise + health_check_timeout: + description: 健康检查不健康阈值 15秒 + format: int64 + type: integer + x-go-name: HealthCheckTimeout + health_check_type: + description: 健康检查开启状态 on|off + type: string + x-go-name: HealthCheckType + health_check_uri: + description: 健康检查域名 yunion.cn + type: string + x-go-name: HealthCheckURI + http_request_rate: + format: int64 + type: integer + x-go-name: HTTPRequestRate + http_request_rate_per_src: + description: 限定监听接收请示速率 + format: int64 + type: integer + x-go-name: HTTPRequestRatePerSrc + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + listener_port: + format: int64 + type: integer + x-go-name: ListenerPort + listener_type: + type: string + x-go-name: ListenerType + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + redirect: + type: string + x-go-name: Redirect + redirect_code: + description: 跳转类型 + format: int64 + type: integer + x-go-name: RedirectCode + redirect_host: + description: 跳转uri scheme + type: string + x-go-name: RedirectHost + redirect_path: + description: 跳转时变更Host + type: string + x-go-name: RedirectPath + redirect_scheme: + description: 跳转HTTP code + type: string + x-go-name: RedirectScheme + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + scheduler: + type: string + x-go-name: Scheduler + send_proxy: + type: string + x-go-name: SendProxy + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + sticky_session: + type: string + x-go-name: StickySession + sticky_session_cookie: + description: Cookie处理方式 insert(植入cookie)|server(重写cookie) + type: string + x-go-name: StickySessionCookie + sticky_session_cookie_timeout: + description: Cookie名称 + format: int64 + type: integer + x-go-name: StickySessionCookieTimeout + sticky_session_type: + description: 会话保持开启状态 on|off + type: string + x-go-name: StickySessionType + tenant_id: + type: string + x-go-name: ProjectId + tls_cipher_policy: + type: string + x-go-name: TLSCipherPolicy + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + xforwarded_for: + type: boolean + x-go-name: XForwardedFor + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerRuleCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Redirect: + type: string + RedirectCode: + format: int64 + type: integer + RedirectHost: + type: string + RedirectPath: + type: string + RedirectScheme: + type: string + backend_group: + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + conditon: + type: string + x-go-name: Condition + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + domain: + type: string + x-go-name: Domain + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + http_request_rate: + format: int64 + type: integer + x-go-name: HttpRequstRate + http_request_rate_per_sec: + format: int64 + type: integer + x-go-name: HttpRequstRatePerSec + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + listener: + description: 'swagger: ignore' + type: string + x-go-name: Listener + listener_id: + type: string + x-go-name: ListenerId + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + path: + type: string + x-go-name: Path + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerRuleDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + backend_group: + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + condition: + type: string + x-go-name: Condition + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain: + type: string + x-go-name: Domain + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + health_check: + type: string + x-go-name: HealthCheck + health_check_domain: + type: string + x-go-name: HealthCheckDomain + health_check_exp: + description: UDP监听健康检查的请求串 + type: string + x-go-name: HealthCheckExp + health_check_fall: + description: 健康检查健康阈值 3秒 + format: int64 + type: integer + x-go-name: HealthCheckFall + health_check_http_code: + description: 健康检查路径 / + type: string + x-go-name: HealthCheckHttpCode + health_check_interval: + description: 健康检查超时时间 10秒 + format: int64 + type: integer + x-go-name: HealthCheckInterval + health_check_req: + type: string + x-go-name: HealthCheckReq + health_check_rise: + format: int64 + type: integer + x-go-name: HealthCheckRise + health_check_timeout: + description: 健康检查不健康阈值 15秒 + format: int64 + type: integer + x-go-name: HealthCheckTimeout + health_check_type: + description: 健康检查开启状态 on|off + type: string + x-go-name: HealthCheckType + health_check_uri: + description: 健康检查域名 yunion.cn + type: string + x-go-name: HealthCheckURI + http_request_rate: + format: int64 + type: integer + x-go-name: HTTPRequestRate + http_request_rate_per_src: + description: 限定监听接收请示速率 + format: int64 + type: integer + x-go-name: HTTPRequestRatePerSrc + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default: + description: 默认转发策略，目前只有aws用到其它云都是false + type: boolean + x-go-name: IsDefault + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + listener: + description: 负载均衡监听器名称 + type: string + x-go-name: Listener + listener_id: + description: 负载均衡监听器ID + type: string + x-go-name: ListenerId + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + path: + type: string + x-go-name: Path + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + redirect: + type: string + x-go-name: Redirect + redirect_code: + description: 跳转类型 + format: int64 + type: integer + x-go-name: RedirectCode + redirect_host: + description: 跳转uri scheme + type: string + x-go-name: RedirectHost + redirect_path: + description: 跳转时变更Host + type: string + x-go-name: RedirectPath + redirect_scheme: + description: 跳转HTTP code + type: string + x-go-name: RedirectScheme + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerRuleUpdateInput: + properties: + Redirect: + type: string + RedirectCode: + format: int64 + type: integer + RedirectHost: + type: string + RedirectPath: + type: string + RedirectScheme: + type: string + backend_group: + type: string + x-go-name: BackendGroup + backend_group_id: + type: string + x-go-name: BackendGroupId + conditon: + type: string + x-go-name: Condition + description: + description: 资源描述 + type: string + x-go-name: Description + domain: + type: string + x-go-name: Domain + http_request_rate: + format: int64 + type: integer + x-go-name: HttpRequstRate + http_request_rate_per_sec: + format: int64 + type: integer + x-go-name: HttpRequstRatePerSec + listener: + description: 'swagger: ignore' + type: string + x-go-name: Listener + listener_id: + type: string + x-go-name: ListenerId + name: + description: 资源名称 + type: string + x-go-name: Name + path: + type: string + x-go-name: Path + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerListenerUpdateInput: + properties: + acl: + description: 'swagger: ignore' + type: string + x-go-name: Acl + acl_id: + type: string + x-go-name: AclId + acl_status: + type: string + x-go-name: AclStatus + acl_type: + type: string + x-go-name: AclType + backend_connect_timeout: + default: 5 + description: range 1-180 + format: int64 + type: integer + x-go-name: BackendConnectTimeout + backend_idle_timeout: + default: 90 + description: range 1-600 + format: int64 + type: integer + x-go-name: BackendIdleTimeout + certificate: + description: 'swagger: ignore' + type: string + x-go-name: Certificate + certificate_id: + type: string + x-go-name: CertificateId + client_idle_timeout: + default: 90 + description: range 1-600 + format: int64 + type: integer + x-go-name: ClientIdleTimeout + client_request_timeout: + default: 10 + description: range 1-600 + format: int64 + type: integer + x-go-name: ClientReqeustTimeout + description: + description: 资源描述 + type: string + x-go-name: Description + enable_http2: + default: true + type: boolean + x-go-name: EnableHttp2 + gzip: + type: boolean + x-go-name: Gzip + health_check: + default: "on" + type: string + x-go-name: HealthCheck + health_check_fail: + default: 2 + description: 2-10 + format: int64 + type: integer + x-go-name: HealthCheckFail + health_check_http_code: + default: http_2xx,http_3xx + type: string + x-go-name: HealthCheckHttpCode + health_check_interval: + default: 30 + description: 5-300 + format: int64 + type: integer + x-go-name: HealthCheckInterval + health_check_path: + type: string + x-go-name: HealthCheckPath + health_check_rise: + default: 5 + description: 2-10 + format: int64 + type: integer + x-go-name: HealthCheckRise + health_check_timeout: + default: 5 + description: 2-120 + format: int64 + type: integer + x-go-name: HealthCheckTimeout + health_check_type: + enum: + - tcp + - ' udp' + - ' http' + type: string + x-go-name: HealthCheckType + http_request_rate: + format: int64 + type: integer + x-go-name: HttpRequestRate + http_request_rate_src: + format: int64 + type: integer + x-go-name: HttpRequestRatePerSrc + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + redirect: + default: "off" + type: string + x-go-name: Redirect + redirect_code: + format: int64 + type: integer + x-go-name: RedirectCode + redirect_host: + type: string + x-go-name: RedirectHost + redirect_path: + type: string + x-go-name: RedirectPath + redirect_scheme: + type: string + x-go-name: RedirectScheme + scheduler: + type: string + x-go-name: Scheduler + send_proxy: + type: string + x-go-name: SendProxy + sticky_session: + type: string + x-go-name: StickySession + sticky_session_cookie: + type: string + x-go-name: StickySessionCookie + sticky_session_cookie_timeout: + format: int64 + type: integer + x-go-name: StickySessionCookieTimeout + sticky_session_type: + type: string + x-go-name: StickySessionType + string: + type: string + x-go-name: HealthCheckDomain + tls_cipher_policy: + type: string + x-go-name: TLSCipherPolicy + x_forwarded_for: + default: true + type: boolean + x-go-name: XForwardedFor + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + LoadbalancerRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MappingRules: + items: + $ref: '#/definitions/ProjectMappingRuleInfo' + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MiscResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MiscResourceDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ModelartsPoolChangeConfigInput: + properties: + NodeCount: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ModelartsPoolCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cidr: + type: string + x-go-name: Cidr + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + node_count: + format: int64 + type: integer + x-go-name: NodeCount + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ModelartsPoolDetails: + description: 资源返回详情 + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ModelartsPoolSkuDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ModelartsPoolSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MongoDBCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MongoDBDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network: + description: IP子网名称 + example: test-network + type: string + x-go-name: Network + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MongoDBRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MountTargetCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + access_group_id: + description: 权限组Id + type: string + x-go-name: AccessGroupId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + file_system_id: + description: 文件系统Id + type: string + x-go-name: FileSystemId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_id: + description: Ip子网名称或Id, network_type == vpc时有效 + type: string + x-go-name: NetworkId + network_type: + default: vpc + description: |- + 网络类型 + enmu: vpc, classic + type: string + x-go-name: NetworkType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - file_system_id + - network_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MountTargetDetails: + properties: + FileSystem: + type: string + access_group: + description: 权限组名称 + type: string + x-go-name: AccessGroup + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network: + description: IP子网名称 + type: string + x-go-name: Network + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区 + type: string + x-go-name: Zone + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + MountTargetSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NasSkuDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatDEntryDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + natgateway: + description: NAT网关名称 + type: string + x-go-name: Natgateway + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatEntryDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + natgateway: + description: NAT网关名称 + type: string + x-go-name: Natgateway + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatGatewaySyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatSEntryDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + natgateway: + description: NAT网关名称 + type: string + x-go-name: Natgateway + network: + $ref: '#/definitions/SimpleNetwork' + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatSkuDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatgatewayCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + auto_renew: + default: false + description: 是否自动续费(仅包年包月时生效) + type: boolean + x-go-name: AutoRenew + billing_type: + description: 计费方式 + enum: + - postpaid + - ' prepaid' + type: string + x-go-name: BillingType + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: 包年包月时间周期 + type: string + x-go-name: Duration + eip: + description: 绑定已有弹性公网IP，要求EIP必须和Vpc在同一区域 + type: string + x-go-name: Eip + eip_auto_dellocate: + type: boolean + x-go-name: EipAutoDellocate + eip_bgp_type: + type: string + x-go-name: EipBgpType + eip_bw: + description: 绑定新建弹性公网IP + format: int64 + type: integer + x-go-name: EipBw + eip_charge_type: + default: traffic + description: 弹性公网IP计费类型 + enum: + - bandwidth + - ' traffic' + type: string + x-go-name: EipChargeType + expired_at: + description: 到期释放时间，仅后付费支持 + format: date-time + type: string + x-go-name: ExpiredAt + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_id: + type: string + x-go-name: NetworkId + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatgatewayDeleteInput: + properties: + force: + type: boolean + x-go-name: Force + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NatgatewayDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + bandwidth_mb: + format: int64 + type: integer + x-go-name: BandwidthMb + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + ip_addr: + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nat_spec: + type: string + x-go-name: NatSpec + network: + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetTapFlowCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + direction: + type: string + x-go-name: Direction + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + guest_id: + type: string + x-go-name: GuestId + host_id: + type: string + x-go-name: HostId + ip_addr: + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + mac_addr: + type: string + x-go-name: MacAddr + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + tap_id: + type: string + x-go-name: TapId + type: + type: string + x-go-name: Type + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + wire_id: + type: string + x-go-name: WireId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetTapFlowDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + net: + type: string + x-go-name: Net + source: + type: string + x-go-name: Source + source_ips: + type: string + x-go-name: SourceIps + tap: + description: 关联的tap服务名称 + type: string + x-go-name: Tap + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetTapServiceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + mac_addr: + description: 监听网卡的Mac地址 + type: string + x-go-name: MacAddr + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + target_id: + description: 资源ID，如果Type=host，该值为宿主机的ID，如果Type=guest，该值为虚拟机的ID + type: string + x-go-name: TargetId + type: + description: TAP服务类型，监听宿主机的网卡还是虚拟机的网卡, 可能值为 host|guest + type: string + x-go-name: Type + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetTapServiceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + flow_count: + description: tap flow数量 + format: int64 + type: integer + x-go-name: FlowCount + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + target: + description: 流量镜像目标名称 + type: string + x-go-name: Target + target_ips: + description: 流量镜像目标IP地址 + type: string + x-go-name: TargetIps + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkAddressCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + GuestId: + type: string + GuestnetworkIndex: + format: int8 + type: integer + IPAddr: + type: string + NetworkId: + type: string + ParentId: + format: int64 + type: integer + ParentType: + type: string + Type: + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkAddressDetails: + properties: + Guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + IpAddr: + type: string + NetworkId: + type: string + ParentId: + type: string + ParentType: + type: string + SubCtrVid: + format: int64 + type: integer + Type: + type: string + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network: + description: IP子网名称 + type: string + x-go-name: Network + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区 + type: string + x-go-name: Zone + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkConfig: + properties: + address: + description: 子网内的IPv4地址, 若不指定会安装子网的地址分配策略分配一个IP地址 + type: string + x-go-name: Address + bw_limit: + format: int64 + type: integer + x-go-name: BwLimit + driver: + description: |- + 驱动方式 + 若指定镜像的网络驱动方式，此参数会被覆盖 + type: string + x-go-name: Driver + exit: + description: 内网地址 + type: boolean + x-go-name: Exit + ifname: + type: string + x-go-name: Ifname + index: + description: 网卡序号, 从0开始 + format: int64 + type: integer + x-go-name: Index + mac: + description: |- + 网卡MAC地址 + requried: false + type: string + x-go-name: Mac + net_type: + type: string + x-go-name: NetType + network: + description: 子网名称或ID + type: string + x-go-name: Network + num_queues: + format: int64 + type: integer + x-go-name: NumQueues + private: + type: boolean + x-go-name: Private + require_designated_ip: + type: boolean + x-go-name: RequireDesignatedIP + require_teaming: + type: boolean + x-go-name: RequireTeaming + reserved: + type: boolean + x-go-name: Reserved + schedtags: + items: + $ref: '#/definitions/SchedtagConfig' + type: array + x-go-name: Schedtags + sriov_device: + $ref: '#/definitions/IsolatedDeviceConfig' + standby_addr_count: + format: int64 + type: integer + x-go-name: StandbyAddrCount + standby_port_count: + format: int64 + type: integer + x-go-name: StandbyPortCount + try_teaming: + type: boolean + x-go-name: TryTeaming + vip: + type: boolean + x-go-name: Vip + required: + - index + - network + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + assign_public_ip: + description: 是否申请ip时自动挂载公网ip，仅对aws生效 + type: boolean + x-go-name: AssignPublicIp + bgp_type: + description: 线路类型 + type: string + x-go-name: BgpType + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + guest_dhcp: + description: 'description: guest dhcp' + example: 192.168.222.1,192.168.222.4 + type: string + x-go-name: GuestDHCP + guest_dns: + description: 'description: guest dns' + example: 114.114.114.114,8.8.8.8 + type: string + x-go-name: GuestDns + guest_gateway: + description: 'description: guest gateway' + example: 192.168.222.1 + type: string + x-go-name: GuestGateway + guest_ip_end: + description: 'description: ip range of guest ip end, if set guest_ip_prefix, + this parameter will be useless' + example: 10.168.222.100 + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + description: 'description: ip range of guest ip mask, if set guest_ip_prefix, + this parameter will be useless' + example: 24 + format: int64 + maximum: 30 + minimum: 12 + type: integer + x-go-name: GuestIpMask + guest_ip_prefix: + description: 'description: ip range of guest, if not set, you shoud set guest_ip_start,guest_ip_end + and guest_ip_mask params' + example: 10.168.222.1/24 + type: string + x-go-name: GuestIpPrefix + guest_ip_start: + description: 'description: ip range of guest ip start, if set guest_ip_prefix, + this parameter will be useless' + example: 10.168.222.1 + type: string + x-go-name: GuestIpStart + guest_ntp: + description: 'description: guest ntp' + example: cn.pool.ntp.org,0.cn.pool.ntp.org + type: string + x-go-name: GuestNtp + ifname_hint: + type: string + x-go-name: IfnameHint + is_auto_alloc: + description: 是否加入自动分配地址池 + type: boolean + x-go-name: IsAutoAlloc + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + server_type: + default: guest + description: 'description: server type' + enum: + - guest + - baremetal + - pxe + - ipmi + type: string + x-go-name: ServerType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vlan: + description: deprecated + format: int64 + type: integer + x-go-name: Vlan + vlan_id: + description: VlanId + format: int64 + type: integer + x-go-name: VlanId + vpc: + description: 'description: vpc id or name' + type: string + x-go-name: Vpc + wire: + description: 'description: wire id or name' + type: string + x-go-name: Wire + zone: + description: 'description: zone id or name' + type: string + x-go-name: Zone + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + alloc_policy: + description: 分配策略 + type: string + x-go-name: AllocPolicy + alloc_timout_seconds: + format: int64 + type: integer + x-go-name: AllocTimoutSeconds + bgp_type: + description: 线路类型 + type: string + x-go-name: BgpType + bm_reused_vnics: + format: int64 + type: integer + x-go-name: BmReusedVnics + bm_vnics: + description: 裸金属网卡数量 + format: int64 + type: integer + x-go-name: BmVnics + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + eip_vnics: + description: 浮动Ip网卡数量 + format: int64 + type: integer + x-go-name: EipVnics + environment: + description: Environment + type: string + x-go-name: Environment + exit: + description: 是否是内网 + type: boolean + x-go-name: Exit + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + group_vnics: + format: int64 + type: integer + x-go-name: GroupVnics + guest_dhcp: + description: allow multiple dhcp, seperated by "," + type: string + x-go-name: GuestDhcp + guest_dns: + description: DNS, allow multiple dns, seperated by "," + type: string + x-go-name: GuestDns + guest_dns6: + type: string + x-go-name: GuestDns6 + guest_domain: + type: string + x-go-name: GuestDomain + guest_domain6: + type: string + x-go-name: GuestDomain6 + guest_gateway: + description: 网关地址 + type: string + x-go-name: GuestGateway + guest_gateway6: + type: string + x-go-name: GuestGateway6 + guest_ip_end: + description: 结束IP地址 + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + description: 掩码 + format: uint8 + type: integer + x-go-name: GuestIpMask + guest_ip_start: + description: 起始IP地址 + type: string + x-go-name: GuestIpStart + guest_ip6_end: + type: string + x-go-name: GuestIp6End + guest_ip6_mask: + format: uint8 + type: integer + x-go-name: GuestIp6Mask + guest_ip6_start: + type: string + x-go-name: GuestIp6Start + guest_ntp: + description: allow mutiple ntp, seperated by "," + type: string + x-go-name: GuestNtp + id: + description: 资源UUID + type: string + x-go-name: Id + ifname_hint: + type: string + x-go-name: IfnameHint + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_auto_alloc: + description: |- + 该网段是否用于自动分配IP地址，如果为false，则用户需要明确选择该网段，才会使用该网段分配IP， + 如果为true，则用户不指定网段时，则自动从该值为true的网络中选择一个分配地址 + type: boolean + x-go-name: IsAutoAlloc + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + lb_vnics: + description: 负载均衡网卡数量 + format: int64 + type: integer + x-go-name: LbVnics + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nat_vnics: + description: NAT网关网卡数量 + format: int64 + type: integer + x-go-name: NatVnics + networkinterface_vnics: + description: 弹性网卡数量 + format: int64 + type: integer + x-go-name: NetworkinterfaceVnics + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + ports: + description: 端口数量 + format: int64 + type: integer + x-go-name: Ports + ports_used: + description: 已使用端口数量 + format: int64 + type: integer + x-go-name: PortsUsed + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + rds_vnics: + description: RDS网卡数量 + format: int64 + type: integer + x-go-name: RdsVnics + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + reserve_vnics: + description: 预留IP数量 + format: int64 + type: integer + x-go-name: ReserveVnics + routes: + description: 路由信息 + items: + items: + type: string + type: array + type: array + x-go-name: Routes + schedtags: + items: + $ref: '#/definitions/SchedtagShortDescDetails' + type: array + x-go-name: Schedtags + server_type: + description: 服务器类型 + example: server + type: string + x-go-name: ServerType + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + total: + format: int64 + type: integer + x-go-name: Total + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + vnics: + description: 虚拟机网卡数量 + format: int64 + type: integer + x-go-name: Vnics + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区 + type: string + x-go-name: Zone + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkInterfaceDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + associate_id: + description: 绑定资源Id + type: string + x-go-name: AssociateId + associate_type: + description: 绑定资源类型 + type: string + x-go-name: AssociateType + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + mac: + description: MAC地址 + type: string + x-go-name: Mac + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + description: 弹性网卡网络信息 + items: + $ref: '#/definitions/NetworkInterfaceNetworkInfo' + type: array + x-go-name: Networks + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkInterfaceNetworkInfo: + properties: + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + description: Ip子网Id + type: string + x-go-name: NetworkId + networkinterface_id: + description: 弹性网卡id + type: string + x-go-name: NetworkinterfaceId + primary: + description: 是否是主ip地址 + type: boolean + x-go-name: Primary + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkIpMacBatchCreateInput: + properties: + ip_mac: + additionalProperties: + type: string + type: object + x-go-name: IpMac + network_id: + type: string + x-go-name: NetworkId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkIpMacCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + ip_addr: + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + mac_addr: + type: string + x-go-name: MacAddr + network_id: + type: string + x-go-name: NetworkId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkIpMacDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + ip_addr: + type: string + x-go-name: IpAddr + mac_addr: + type: string + x-go-name: MacAddr + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + network_id: + type: string + x-go-name: NetworkId + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkIpMacUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + ip_addr: + type: string + x-go-name: IpAddr + mac_addr: + type: string + x-go-name: MacAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkMergeInput: + properties: + target: + description: 'description: network id or name to be merged' + example: test-network + type: string + x-go-name: Target + required: + - target + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkPurgeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkReleaseReservedIpInput: + properties: + ip: + description: 'description: IP to be released' + example: 10.168.222.121 + type: string + x-go-name: Ip + required: + - ip + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkReserveIpInput: + properties: + duration: + description: 'description: The reserved cycle' + type: string + x-go-name: Duration + ips: + description: 'description: reserved ip list' + example: '[10.168.222.131, 10.168.222.134]' + items: + type: string + type: array + x-go-name: Ips + notes: + description: 'description: the comment' + example: reserve ip for test + type: string + x-go-name: Notes + status: + type: string + x-go-name: Status + required: + - ips + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkSetBgpTypeInput: + properties: + bgp_type: + description: 'description: new BgpType name' + example: ChinaTelecom, BGP, etc. + type: string + x-go-name: BgpType + required: + - bgp_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkSplitInput: + properties: + name: + description: 'description: another network name after split' + type: string + x-go-name: Name + split_ip: + description: 'description: The middle - separated IP must belong to the network' + example: 10.168.222.181 + type: string + x-go-name: SplitIp + required: + - split_ip + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkSwitchWireInput: + properties: + wire_id: + description: 'description: new wire Id or name' + example: bcast0 + type: string + x-go-name: WireId + required: + - wire_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkSyncInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkTopologyOutput: + properties: + address: + items: + $ref: '#/definitions/SNetworkUsedAddress' + type: array + x-go-name: Address + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + format: int8 + type: integer + x-go-name: GuestIpMask + guest_ip_start: + type: string + x-go-name: GuestIpStart + name: + type: string + x-go-name: Name + server_type: + type: string + x-go-name: ServerType + status: + type: string + x-go-name: Status + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkTryCreateNetworkInput: + properties: + ip: + type: string + x-go-name: Ip + is_on_premise: + type: boolean + x-go-name: IsOnPremise + mask: + format: int64 + type: integer + x-go-name: Mask + server_type: + type: string + x-go-name: ServerType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + NetworkUpdateInput: + properties: + alloc_policy: + description: 分配策略 + type: string + x-go-name: AllocPolicy + description: + description: 资源描述 + type: string + x-go-name: Description + guest_dhcp: + description: allow multiple dhcp, seperated by "," + type: string + x-go-name: GuestDhcp + guest_dns: + description: DNS + type: string + x-go-name: GuestDns + guest_domain: + type: string + x-go-name: GuestDomain + guest_gateway: + description: 网关地址 + type: string + x-go-name: GuestGateway + guest_ip_end: + description: 接收IP地址 + type: string + x-go-name: GuestIpEnd + guest_ip_mask: + description: 掩码 + format: int8 + type: integer + x-go-name: GuestIpMask + guest_ip_start: + description: 起始IP地址 + type: string + x-go-name: GuestIpStart + guest_ntp: + description: NTP + type: string + x-go-name: GuestNtp + is_auto_alloc: + description: 是否加入自动分配地址池 + type: boolean + x-go-name: IsAutoAlloc + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PerformChangeDomainOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformChangeProjectOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformFreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicDomainInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicProjectInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + shared_project_ids: + description: 如果共享范围为项目，则在此列表中指定共享的目标项目 + items: + type: string + type: array + x-go-name: SharedProjectIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformUnfreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PolicyAssignmentCreateInput: + properties: + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + name: + description: 资源名称 + type: string + x-go-name: Name + policydefinition_id: + description: 策略Id + type: string + x-go-name: PolicydefinitionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PolicyAssignmentDetails: + properties: + Policydefinition: + type: string + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + policydefinition_id: + description: 策略Id + type: string + x-go-name: PolicydefinitionId + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PolicyDefinitionCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + category: + description: 类别 + type: string + x-go-name: Category + condition: + description: 条件 + type: string + x-go-name: Condition + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + name: + description: 资源名称 + example: test-network + type: string + uniqueItems: true + x-go-name: Name + parameters: + description: 参数 + type: object + x-go-name: Parameters + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PolicyDefinitionDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + category: + description: 类别 + type: string + x-go-name: Category + condition: + description: 条件 + type: string + x-go-name: Condition + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + parameters: + description: 参数 + type: object + x-go-name: Parameters + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PostpaidExpireInput: + properties: + duration: + type: string + x-go-name: Duration + expire_time: + format: date-time + type: string + x-go-name: ExpireTime + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProjectMappingCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Rules: + $ref: '#/definitions/MappingRules' + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectMappingDetails: + properties: + Rules: + items: + $ref: '#/definitions/ProjectMappingRuleInfoDetails' + type: array + accounts: + description: 所绑定的云账号列表 + items: + $ref: '#/definitions/SProjectMappingAccount' + type: array + x-go-name: Accounts + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + managers: + description: 所绑定的云订阅列表 + items: + $ref: '#/definitions/SProjectMappingAccount' + type: array + x-go-name: Managers + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectMappingRuleInfo: + properties: + auto_create_project: + description: 是否自动根据标签值创建项目, 仅标签列表中有且仅有一个没有value的key时支持 + type: boolean + x-go-name: AutoCreateProject + condition: + default: and + description: |- + 条件表达式 + enmu: and, or + type: string + x-go-name: Condition + project_id: + description: 符合条件时，资源放置的项目id, 此参数和auto_create_project互斥 + type: string + x-go-name: ProjectId + tags: + $ref: '#/definitions/TTagSet' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectMappingRuleInfoDetails: + properties: + Domain: + type: string + Project: + type: string + Tenant: + type: string + TenantId: + type: string + auto_create_project: + description: 是否自动根据标签值创建项目, 仅标签列表中有且仅有一个没有value的key时支持 + type: boolean + x-go-name: AutoCreateProject + condition: + default: and + description: |- + 条件表达式 + enmu: and, or + type: string + x-go-name: Condition + project_id: + description: 符合条件时，资源放置的项目id, 此参数和auto_create_project互斥 + type: string + x-go-name: ProjectId + tags: + $ref: '#/definitions/TTagSet' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectMappingUpdateInput: + properties: + Rules: + $ref: '#/definitions/MappingRules' + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ProjectStatistic: + properties: + Count: + format: int64 + type: integer + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProviderProject: + properties: + tenant: + description: 子订阅项目名称 + example: system + type: string + x-go-name: Tenant + tenant_id: + description: |- + 子订阅项目Id + 9a48383a-467a-4542-8b50-4e15b0a8715f + type: string + x-go-name: TenantId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + RenewInput: + properties: + duration: + type: string + x-go-name: Duration + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ReservedipDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + environment: + description: Environment + type: string + x-go-name: Environment + expired: + description: 是否过期 + type: boolean + x-go-name: Expired + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + id: + description: 自增Id + format: int64 + type: integer + x-go-name: Id + ip_addr: + description: IP地址 + type: string + x-go-name: IpAddr + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + network: + description: IP子网名称 + type: string + x-go-name: Network + network_id: + type: string + x-go-name: NetworkId + notes: + description: 预留原因或描述 + type: string + x-go-name: Notes + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + status: + description: 状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + wire: + description: 二层网络(WIRE)的名称 + type: string + x-go-name: Wire + wire_id: + description: 二层网络ID + type: string + x-go-name: WireId + zone: + description: 可用区 + type: string + x-go-name: Zone + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + RouteTableCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + routes: + $ref: '#/definitions/SRoutes' + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + RouteTableDetails: + properties: + AccociationCount: + format: int64 + type: integer + RouteSetCount: + format: int64 + type: integer + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + routes: + $ref: '#/definitions/SRoutes' + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + RouteTableRouteSetCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + RouteTableId: + type: string + cidr: + type: string + x-go-name: Cidr + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + ext_next_hop_id: + type: string + x-go-name: ExtNextHopId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + next_hop_id: + type: string + x-go-name: NextHopId + next_hop_type: + type: string + x-go-name: NextHopType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + RouteTableRouteSetUpdateInput: + properties: + cidr: + type: string + x-go-name: Cidr + description: + description: 资源描述 + type: string + x-go-name: Description + ext_next_hop_id: + type: string + x-go-name: ExtNextHopId + name: + description: 资源名称 + type: string + x-go-name: Name + next_hop_id: + type: string + x-go-name: NextHopId + next_hop_type: + type: string + x-go-name: NextHopType + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + RouteTableUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + routes: + $ref: '#/definitions/SRoutes' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SAccountPermission: + properties: + Permissions: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SAccountPermissions: + additionalProperties: + $ref: '#/definitions/SAccountPermission' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SAclEntries: + items: + $ref: '#/definitions/SAclEntry' + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SAclEntry: + properties: + Cidr: + type: string + Comment: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SBucketAccessUrl: + properties: + Description: + type: string + Primary: + type: boolean + Url: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCdnOrigin: + description: +onecloud:model-api-gen + properties: + Enabled: + type: string + Origin: + description: 源站地址 + type: string + Path: + type: string + Port: + format: int64 + type: integer + Priority: + format: int64 + type: integer + Protocol: + description: |- + 回源协议 + enmu: http, follow, https + type: string + ServerName: + description: 回主源站时 Host 头部 + type: string + Type: + description: |- + 源站类型 + domain: 域名类型, cos：对象存储源站, ip：IP 列表作为源站 + enmu: domain, cos, ip + type: string + required: + - Type + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCdnOrigins: + description: +onecloud:model-api-gen + items: + $ref: '#/definitions/SCdnOrigin' + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCloudObject: + properties: + Acl: + type: string + ETag: + type: string + Key: + type: string + LastModified: + format: date-time + type: string + Meta: + $ref: '#/definitions/Header' + SizeBytes: + format: int64 + type: integer + StorageClass: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCloudResource: + properties: + CanDissociate: + description: 是否可以解除关联 + type: boolean + Id: + description: 资源Id + type: string + Name: + description: 资源名称 + type: string + Port: + description: 资源映射端口 + format: int64 + type: integer + Type: + description: 资源类型 + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCloudResources: + properties: + Data: + items: + $ref: '#/definitions/SCloudResource' + type: array + Total: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SCloudaccountCredential: + properties: + As: + description: 弹性伸缩服务 + type: string + Bms: + description: 裸金属服务器 + type: string + Bss: + description: 合作伙伴运营能力 + type: string + Cce: + description: 云容器服务 + type: string + Cci: + description: 云容器实例 CCI + type: string + Ces: + description: 监控服务 CloudEye + type: string + Csbs: + description: 云服务器备份服务 + type: string + Cts: + description: 云审计服务 + type: string + Dcs: + description: 分布式缓存服务 + type: string + DefaultRegion: + description: 默认区域Id, Apara及HCSO需要此参数 + example: cn-north-2 + type: string + DefaultSubnetDns: + description: 默认DNS + example: 10.125.0.26,10.125.0.27 + type: string + Ecs: + description: 弹性云服务 + type: string + Elb: + description: 弹性负载均衡 ELB + type: string + EndpointDomain: + description: 华为私有云Endpoint域名 + example: hcso.com.cn + type: string + Eps: + description: 企业项目 + type: string + Evs: + description: 云硬盘 EVS + type: string + Iam: + description: 统一身份认证服务 + type: string + Ims: + description: 镜像服务 + type: string + Modelarts: + description: Modelarts + type: string + Nat: + description: Nat网关 NAT + type: string + Obs: + description: 对象存储服务 OBS + type: string + Rds: + description: 关系型数据库 RDS + type: string + SfsTurbo: + description: 文件系统 + type: string + Vbs: + description: 云硬盘备份 VBS + type: string + Vpc: + description: 虚拟私有云 VPC + type: string + access_key_id: + description: 秘钥id (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeyId + access_key_secret: + description: 秘钥key (Aliyun, Aws, huawei, ucloud, ctyun, zstack, s3) + type: string + x-go-name: AccessKeySecret + app_id: + description: app id (Qcloud) + type: string + x-go-name: AppId + auto_url: + description: 认证地址 (openstack,zstack) + type: string + x-go-name: AuthUrl + client_id: + description: 客户端ID (Azure) + type: string + x-go-name: ClientId + client_secret: + description: 客户端秘钥 (Azure) + type: string + x-go-name: ClientSecret + crm_biz_id: + description: customInfo type=1 + type: string + x-go-name: CrmBizId + directory_id: + description: 目录ID (Azure) + type: string + x-go-name: DirectoryId + domain_name: + default: Default + description: 账号所在的域 (openstack) + type: string + x-go-name: DomainName + endpoint: + description: 端点 (s3) 或 Apsara(飞天) + type: string + x-go-name: Endpoint + environment: + description: 环境 (Azure, Aws, huawei, ctyun, aliyun) + type: string + x-go-name: Environment + gcp_client_email: + description: Google服务账号email (gcp) + type: string + x-go-name: GCPClientEmail + gcp_private_key: + description: Google服务账号秘钥 (gcp) + type: string + x-go-name: GCPPrivateKey + gcp_private_key_id: + description: Google服务账号秘钥id (gcp) + type: string + x-go-name: GCPPrivateKeyId + gcp_project_id: + description: Google服务账号project id (gcp) + type: string + x-go-name: GCPProjectId + host: + description: 主机IP (esxi) + type: string + x-go-name: Host + organization_id: + description: 飞天允许的最高组织id, 默认为1 + format: int64 + type: integer + x-go-name: OrganizationId + password: + description: 密码 (openstack, zstack, esxi) + type: string + x-go-name: Password + port: + description: 主机端口 (esxi) + format: int64 + type: integer + x-go-name: Port + project_name: + description: 账号所在的项目 (openstack) + type: string + x-go-name: ProjectName + secret_id: + description: 秘钥ID (Qcloud) + type: string + x-go-name: SecretId + secret_key: + description: 秘钥key (Qcloud) + type: string + x-go-name: SecretKey + username: + description: 用户名 (openstack, zstack, esxi) + type: string + x-go-name: Username + required: + - EndpointDomain + - DefaultRegion + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SDBInstanceAccountPrivilege: + properties: + database: + description: 数据库名称或Id + type: string + x-go-name: Database + privilege: + description: |- + 权限类型 + + + + 平台 |Rds引擎 | 支持类型 | + ---- |------- | -------- | + Aliyun |MySQL, MariaBD | rw, r, ddl, dml | + Aliyun |SQLServer | rw, r, owner | + Huawei |MySQL, MariaDB | rw, r | + 同一平台不同的rds类型支持的权限不尽相同 + type: string + x-go-name: Privilege + required: + - database + - privilege + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SDBInstanceChangeConfigInput: + properties: + DiskSizeGB: + format: int64 + type: integer + InstanceType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SDBInstanceDatabasePrivilege: + properties: + account: + description: 数据库账号名称或Id + type: string + x-go-name: Account + privilege: + description: |- + 权限 + + + + 平台 |Rds引擎 | 支持类型 | + ---- |------- | -------- | + Aliyun |MySQL, MariaBD | rw, r, ddl, dml | + Aliyun |SQLServer | rw, r, owner | + Huawei |MySQL, MariaDB | rw, r | + 同一平台不同的rds类型支持的权限不尽相同 + type: string + x-go-name: Privilege + required: + - account + - privilege + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SDBInstanceRecoveryConfigInput: + properties: + databases: + additionalProperties: + type: string + description: 数据库信息, 例如 {"src":"dest"} 是将备份中的src数据库恢复到目标实例的dest数据库中, 阿里云此参数为必传 + example: + sdb1: ddb1 + type: object + x-go-name: Databases + dbinstancebackup_id: + description: |- + 备份Id + + + 平台 | 支持引擎 | 说明 | + ----- | ------ | --- | + 华为云 |MySQL, SQL Server | 仅SQL Server支持恢复到当前实例 | + 阿里云 |MySQL, SQL Server | MySQL要求必须开启单库单表恢复功能 并且只能是MySQL 8.0 高可用版（本地SSD盘）MySQL 5.7 高可用版（本地SSD盘）或MySQL 5.6 高可用版, MySQL仅支持恢复到当前实例| + Google |MySQL, PostgreSQL, SQL Server | PostgreSQL备份恢复时，要求实例不能有副本 | + type: string + x-go-name: DBInstancebackupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SDomainQuotaDetail: + description: 域配额详情 + properties: + cloudaccount: + format: int64 + type: integer + x-go-name: Cloudaccount + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + dns_zone: + format: int64 + type: integer + x-go-name: DnsZone + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + globalvpc: + format: int64 + type: integer + x-go-name: Globalvpc + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SElasticipCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + bandwidth: + format: int64 + type: integer + x-go-name: BandwidthMb + bgp_type: + description: 'description: BgpType for the new eip' + type: string + x-go-name: BgpType + charge_type: + default: traffic + description: |- + 计费类型: 流量或带宽 + + + + 平台 | 支持类型 | + --- | -------- | + Aliyun | traffic, bandwidth | + 腾讯云 | traffic | + Azure | traffic | + Google | traffic, bandwidth | + Ucloud | traffic | + Aws | traffic | + 华为云 | traffic, bandwidth | + 天翼云 | traffic, bandwidth | + KVM | 不支持创建 | + VMware | 不支持创建 | + ZStack | traffic | + OpenStack | traffic | + enum: + - traffic + - ' bandwidth' + type: string + x-go-name: ChargeType + cloudregion_id: + description: |- + 区域名称或Id, 建议使用Id + 在指定区域内创建弹性公网ip + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + ip_addr: + description: 指定新建EIP的地址 + type: string + x-go-name: IpAddr + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + manager_id: + description: |- + 子订阅Id, 建议使用Id + 使用指定子订阅创建弹性公网ip + 弹性公网ip和虚拟机在同一区域同一子订阅底下，才可以进行绑定操作 + type: string + x-go-name: ManagerId + mode: + type: string + x-go-name: Mode + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + network_id: + description: |- + 子网Id + 私有云创建此参数必传,例如Openstack, ZStack + type: string + x-go-name: NetworkId + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SEnrollmentAccount: + properties: + id: + description: Enrollment Account Id + type: string + x-go-name: Id + name: + description: Enrollment Account name + type: string + x-go-name: Name + type: + description: Enrollment Account 类型 + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SExcludeRule: + properties: + Name: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SExcludeRules: + items: + $ref: '#/definitions/SExcludeRule' + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SGPerformDetachScalingGroupInput: + properties: + auto: + description: 'description: 自动行为' + example: true + type: boolean + x-go-name: Auto + delete_server: + description: 'description: 是否删除机器' + example: false + type: boolean + x-go-name: DeleteServer + scaling_group: + description: 'description: 伸缩组 Id or Name' + example: sg-1234 + type: string + x-go-name: ScalingGroup + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SGroup: + properties: + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + force_dispersion: + type: boolean + x-go-name: ForceDispersion + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + granularity: + description: the upper limit number of guests with this group in a host + format: int64 + type: integer + x-go-name: Granularity + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + name: + description: 资源名称 + type: string + x-go-name: Name + parent_id: + type: string + x-go-name: ParentId + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + sched_strategy: + description: 调度策略 + type: string + x-go-name: SchedStrategy + service_type: + description: 服务类型 + type: string + x-go-name: ServiceType + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone_id: + type: string + x-go-name: ZoneId + title: SGroup is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SGroup. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SGuest: + properties: + admin_secgrp_id: + description: 管理员可见安全组Id + type: string + x-go-name: AdminSecgrpId + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backup_guest_status: + type: string + x-go-name: BackupGuestStatus + backup_host_id: + description: 备份机所在宿主机Id + type: string + x-go-name: BackupHostId + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + bios: + type: string + x-go-name: Bios + boot_order: + description: 启动顺序 + type: string + x-go-name: BootOrder + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + flavor_id: + type: string + x-go-name: FlavorId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + host_id: + type: string + x-go-name: HostId + hostname: + type: string + x-go-name: Hostname + hypervisor: + description: 虚拟化技术 + example: kvm + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + type: string + x-go-name: InstanceType + internet_max_bandwidth_out: + description: 最大内网带宽 + format: int64 + type: integer + x-go-name: InternetMaxBandwidthOut + is_daemon: + type: boolean + x-go-name: IsDaemon + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + keypair_id: + description: 秘钥对Id + type: string + x-go-name: KeypairId + machine: + type: string + x-go-name: Machine + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + os_type: + description: 操作系统类型 + type: string + x-go-name: OsType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + power_states: + description: power_states limit in [on, off, unknown] + type: string + x-go-name: PowerStates + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + progress_mbps: + description: 迁移或克隆的速度 + format: double + type: number + x-go-name: ProgressMbps + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + qga_status: + type: string + x-go-name: QgaStatus + record_checksum: + type: string + x-go-name: RecordChecksum + secgrp_id: + description: 安全组Id + example: default + type: string + x-go-name: SecgrpId + shutdown_behavior: + description: 关机操作类型 + example: stop + type: string + x-go-name: ShutdownBehavior + shutdown_mode: + description: 关机收费模式 + example: keep_charging, stop_charging + type: string + x-go-name: ShutdownMode + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + src_ip_check: + type: boolean + x-go-name: SrcIpCheck + src_mac_check: + type: boolean + x-go-name: SrcMacCheck + sshable_last_state: + type: boolean + x-go-name: SshableLastState + status: + description: 资源状态 + type: string + x-go-name: Status + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + throughput: + description: 磁盘吞吐量 + format: int64 + type: integer + x-go-name: Throughput + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vcpu_count: + description: CPU大小 + format: int64 + type: integer + x-go-name: VcpuCount + vdi: + type: string + x-go-name: Vdi + vga: + type: string + x-go-name: Vga + vmem_size: + description: 内存大小, 单位Mb + format: int64 + type: integer + x-go-name: VmemSize + title: SGuest is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SGuest. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SHostPingInput: + properties: + memory_used_mb: + format: int64 + type: integer + x-go-name: MemoryUsedMb + root_partition_used_capacity_mb: + format: int64 + type: integer + x-go-name: RootPartitionUsedCapacityMb + storage_stats: + items: + $ref: '#/definitions/SHostStorageStat' + type: array + x-go-name: StorageStats + with_data: + type: boolean + x-go-name: WithData + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SHostStorageStat: + properties: + actual_capacity_used_mb: + format: int64 + type: integer + x-go-name: ActualCapacityUsedMb + capacity_mb: + format: int64 + type: integer + x-go-name: CapacityMb + storage_id: + type: string + x-go-name: StorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SHostTapConfig: + properties: + mirrors: + items: + $ref: '#/definitions/SMirrorConfig' + type: array + x-go-name: Mirrors + taps: + items: + $ref: '#/definitions/STapServiceConfig' + type: array + x-go-name: Taps + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SInfrasQuotaDetail: + description: 基础设施配额详情 + properties: + account: + description: 配额适用的云账号名称 + type: string + x-go-name: Account + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + host: + format: int64 + type: integer + x-go-name: Host + manager: + description: 配额适用的云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region: + description: 配额适用的区域名称 + type: string + x-go-name: Region + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + format: int64 + type: integer + x-go-name: Vpc + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SInstanceTypes: + items: + type: string + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SIsolatedDevice: + properties: + addr: + description: '# pci address of `Bus:Device.Function` format, or usb bus address + of `bus.addr`' + type: string + x-go-name: Addr + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + dev_type: + description: |- + # PCI / GPU-HPC / GPU-VGA / USB / NIC + 设备类型 + type: string + x-go-name: DevType + disk_index: + description: guest disk index + format: uint8 + type: integer + x-go-name: DiskIndex + guest_id: + description: 云主机Id + type: string + x-go-name: GuestId + host_id: + type: string + x-go-name: HostId + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + model: + description: '# Specific device name read from lspci command, e.g. `Tesla + K40m` ...' + type: string + x-go-name: Model + name: + description: 资源名称 + type: string + x-go-name: Name + network_index: + description: guest network index + format: uint8 + type: integer + x-go-name: NetworkIndex + nvme_size_mb: + description: NVME disk size + format: int64 + type: integer + x-go-name: NvmeSizeMB + ovs_offload_interface: + description: Offload interface name + type: string + x-go-name: OvsOffloadInterface + reserved_cpu: + description: reserved cpu count for isolated device + format: int64 + type: integer + x-go-name: ReservedCpu + reserved_memory: + description: reserved memory size for isolated device + format: int64 + type: integer + x-go-name: ReservedMemory + reserved_storage: + description: reserved storage size for isolated device + format: int64 + type: integer + x-go-name: ReservedStorage + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vendor_device_id: + type: string + x-go-name: VendorDeviceId + wire_id: + description: Nic wire id + type: string + x-go-name: WireId + title: SIsolatedDevice is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SIsolatedDevice. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SKafkaTopic: + properties: + Description: + type: string + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SKubeNetworkIds: + items: + type: string + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SKubeconfig: + properties: + config: + type: string + x-go-name: Config + expiration: + format: date-time + type: string + x-go-name: Expiration + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SLoadbalancerAgentDeployment: + properties: + ansible_playbook: + type: string + x-go-name: AnsiblePlaybook + ansible_playbook_undeployment: + type: string + x-go-name: AnsiblePlaybookUndeployment + host: + type: string + x-go-name: Host + title: SLoadbalancerAgentDeployment is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentDeployment. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SLoadbalancerAgentParams: + properties: + haproxy_conf_tmpl: + type: string + x-go-name: HaproxyConfTmpl + keepalived_conf_tmpl: + type: string + x-go-name: KeepalivedConfTmpl + telegraf_conf_tmpl: + type: string + x-go-name: TelegrafConfTmpl + title: SLoadbalancerAgentParams is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentParams. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SLoadbalancerClusterParams: + properties: + advert_int: + format: int64 + type: integer + x-go-name: AdvertInt + garp_master_refresh: + format: int64 + type: integer + x-go-name: GarpMasterRefresh + pass: + type: string + x-go-name: Pass + preempt: + type: boolean + x-go-name: Preempt + virtual_router_id: + format: int64 + type: integer + x-go-name: VirtualRouterId + title: SLoadbalancerClusterParams is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerClusterParams. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SMirrorConfig: + properties: + bridge: + type: string + x-go-name: Bridge + direction: + type: string + x-go-name: Direction + flow_id: + format: uint16 + type: integer + x-go-name: FlowId + host_ip: + type: string + x-go-name: HostIp + port: + type: string + x-go-name: Port + tap_host_ip: + type: string + x-go-name: TapHostIp + vlan_id: + format: int64 + type: integer + x-go-name: VlanId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SMongoDBBackup: + properties: + BackupMethod: + $ref: '#/definitions/TMongoDBBackupMethod' + BackupSizeKb: + format: int64 + type: integer + BackupType: + $ref: '#/definitions/TMongoDBBackupType' + Description: + type: string + EndTime: + format: date-time + type: string + Name: + type: string + StartTime: + format: date-time + type: string + Status: + $ref: '#/definitions/TMongoDBBackupStatus' + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SMongoDBBackups: + properties: + Data: + items: + $ref: '#/definitions/SMongoDBBackup' + type: array + Total: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SNatDCreateInput: + properties: + ExternalIp: + type: string + ExternalPort: + format: int64 + type: integer + InternalIp: + type: string + InternalPort: + format: int64 + type: integer + IpProtocol: + type: string + Name: + type: string + NatgatewayId: + type: string + eip: + type: string + x-go-name: Eip + external_ip_id: + type: string + x-go-name: ExternalIpId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SNatSCreateInput: + properties: + Ip: + description: 'swagger: ignore' + type: string + Name: + type: string + NatgatewayId: + type: string + NetworkId: + type: string + SourceCidr: + type: string + eip: + type: string + x-go-name: Eip + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SNetworkUsedAddress: + properties: + AssociateId: + type: string + AssociateType: + type: string + CreatedAt: + format: date-time + type: string + IpAddr: + type: string + MacAddr: + type: string + Owner: + type: string + OwnerId: + type: string + OwnerStatus: + type: string + OwnerType: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SProjectMappingAccount: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SProjectQuotaDetail: + description: 项目配额详情 + properties: + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + secgroup: + format: int64 + type: integer + x-go-name: Secgroup + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SProxySetting: + properties: + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + http_proxy: + type: string + x-go-name: HTTPProxy + https_proxy: + type: string + x-go-name: HTTPSProxy + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: 资源名称 + type: string + x-go-name: Name + no_proxy: + type: string + x-go-name: NoProxy + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + title: SProxySetting is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudcommon/db/proxy.SProxySetting. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/cloudcommon/proxy + SQuotaDetail: + description: 主机配额详情 + properties: + Hypervisor: + description: 主机配额适用的主机类型，参考主机List的Hypervisor列表 + type: string + account: + description: 配额适用的云账号名称 + type: string + x-go-name: Account + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + count: + description: 主机数量配额 + format: int64 + type: integer + x-go-name: Count + cpu: + description: 主机CPU核数量配额 + format: int64 + type: integer + x-go-name: Cpu + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + group: + description: 主机组配额 + format: int64 + type: integer + x-go-name: Group + isolated_device: + description: 直通设备(GPU)配额 + format: int64 + type: integer + x-go-name: IsolatedDevice + manager: + description: 配额适用的云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + memory: + description: 主机内存容量配额 + format: int64 + type: integer + x-go-name: Memory + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region: + description: 配额适用的区域名称 + type: string + x-go-name: Region + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + storage: + description: 主机存储容量配额 + format: int64 + type: integer + x-go-name: Storage + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone: + description: 配额适用的可用区名称 + type: string + x-go-name: Zone + zone_id: + description: 配额适用的可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SRegionQuotaDetail: + description: 区域配额详情 + properties: + account: + description: 配额适用的云账号名称 + type: string + x-go-name: Account + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + bucket: + format: int64 + type: integer + x-go-name: Bucket + cache: + format: int64 + type: integer + x-go-name: Cache + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + eip: + format: int64 + type: integer + x-go-name: Eip + eport: + format: int64 + type: integer + x-go-name: Eport + instance_snapshot: + format: int64 + type: integer + x-go-name: InstanceSnapshot + loadbalancer: + format: int64 + type: integer + x-go-name: Loadbalancer + manager: + description: 配额适用的云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + mongodb: + format: int64 + type: integer + x-go-name: Mongodb + object_cnt: + format: int64 + type: integer + x-go-name: ObjectCnt + object_gb: + format: int64 + type: integer + x-go-name: ObjectGB + port: + format: int64 + type: integer + x-go-name: Port + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + rds: + format: int64 + type: integer + x-go-name: Rds + region: + description: 配额适用的区域名称 + type: string + x-go-name: Region + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + snapshot: + format: int64 + type: integer + x-go-name: Snapshot + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SRoute: + properties: + cidr: + type: string + x-go-name: Cidr + next_hop_id: + type: string + x-go-name: NextHopId + next_hop_type: + type: string + x-go-name: NextHopType + type: + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SRoutes: + items: + $ref: '#/definitions/SRoute' + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSecgroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + rules: + description: 规则列表 + items: + $ref: '#/definitions/SSecgroupRuleCreateInput' + type: array + x-go-name: Rules + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSecgroupRuleCreateInput: + properties: + action: + description: |- + 行为 + deny: 拒绝 + allow: 允许 + enum: + - deny + - ' allow' + type: string + x-go-name: Action + cidr: + description: ip或cidr地址, 若指定peer_secgroup_id此参数不生效 + example: 192.168.222.121 + type: string + x-go-name: CIDR + description: + description: |- + 规则描述信息 + requried: false + example: test to create rule + type: string + x-go-name: Description + direction: + description: 方向 + enum: + - in + - ' out' + type: string + x-go-name: Direction + ports: + description: |- + 端口列表, 参数为空代表任意端口 + 此参数仅对protocol是tcp, udp时生效 + 支持格式: + 格式类型 | 举例 | + -------- | ---- | + 单端口 | 22 | + 端口范围 | 100-200 | + 不连续端口| 80,443 | + requried: false + type: string + x-go-name: Ports + priority: + description: 优先级, 数字越大优先级越高 + format: int64 + maximum: 100 + minimum: 1 + type: integer + x-go-name: Priority + protocol: + description: 协议 + enum: + - any + - ' tcp' + - ' udp' + - ' icmp' + type: string + x-go-name: Protocol + secgroup_id: + description: 安全组ID + type: string + x-go-name: SecgroupId + required: + - priority + - protocol + - direction + - action + - secgroup_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSecgroupRuleUpdateInput: + properties: + action: + description: |- + 行为 + deny: 拒绝 + allow: 允许 + enum: + - deny + - ' allow' + type: string + x-go-name: Action + cidr: + description: ip或cidr地址, 若指定peer_secgroup_id此参数不生效 + example: 192.168.222.121 + type: string + x-go-name: CIDR + description: + description: |- + 规则描述信息 + requried: false + example: test to create rule + type: string + x-go-name: Description + direction: + description: 方向 + enum: + - in + - ' out' + type: string + x-go-name: Direction + ports: + description: |- + 端口列表, 参数为空代表任意端口 + 此参数仅对protocol是tcp, udp时生效 + 支持格式: + 格式类型 | 举例 | + -------- | ---- | + 单端口 | 22 | + 端口范围 | 100-200 | + 不连续端口| 80,443 | + requried: false + type: string + x-go-name: Ports + priority: + description: 优先级, 数字越大优先级越高 + format: int64 + maximum: 100 + minimum: 1 + type: integer + x-go-name: Priority + protocol: + description: 协议 + enum: + - any + - ' tcp' + - ' udp' + - ' icmp' + type: string + x-go-name: Protocol + required: + - priority + - protocol + - direction + - action + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSimpleBackup: + properties: + backup_storage_id: + description: 备份存储Id + type: string + x-go-name: BackupStorageId + created_at: + description: 创建时间 + format: date-time + type: string + x-go-name: CreatedAt + disk_size_mb: + description: 磁盘大小 + format: int64 + type: integer + x-go-name: DiskSizeMb + disk_type: + description: 磁盘类型 + type: string + x-go-name: DiskType + encrypt_key_id: + description: 密钥 + type: string + x-go-name: EncryptKeyId + id: + description: 备份Id + type: string + x-go-name: Id + name: + description: 备份名称 + type: string + x-go-name: Name + size_mb: + description: 备份大小 + format: int64 + type: integer + x-go-name: SizeMb + status: + description: 快照状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SSubAccount: + properties: + Account: + description: 输入必填，若为空，需要指定子账号名称 + type: string + DefaultProjectId: + type: string + Desc: + description: 描述信息 + type: string + HealthStatus: + type: string + Name: + description: 若Account不为空，可不传 + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + STapServiceConfig: + properties: + Mirrors: + items: + $ref: '#/definitions/SMirrorConfig' + type: array + ifname: + type: string + x-go-name: Ifname + mac_addr: + type: string + x-go-name: MacAddr + tap_host_ip: + type: string + x-go-name: TapHostIp + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SWafRule: + properties: + action: + $ref: '#/definitions/DefaultAction' + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + name: + description: 资源名称 + type: string + x-go-name: Name + priority: + description: 规则优先级 + format: int64 + type: integer + x-go-name: Priority + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + statement_conditon: + description: 条件 + type: string + x-go-name: StatementConditon + status: + description: 资源状态 + type: string + x-go-name: Status + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_instance_id: + description: 所属waf实例id + type: string + x-go-name: WafInstanceId + waf_rule_group_id: + description: 规则组的id + type: string + x-go-name: WafRuleGroupId + title: SWafRule is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SWafRule. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SWafStatement: + description: +onecloud:model-api-gen + properties: + ExcludeRules: + $ref: '#/definitions/SExcludeRules' + ForwardedIPHeader: + type: string + IPSetId: + type: string + ManagedRuleGroupName: + description: 管理规则组名称 + type: string + MatchField: + $ref: '#/definitions/TWafMatchField' + MatchFieldKey: + description: 匹配字段的key + type: string + MatchFieldValues: + $ref: '#/definitions/TWafMatchFieldValues' + Negation: + description: 是否取反操作, 仅对Azure生效 + type: boolean + Operator: + $ref: '#/definitions/TWafOperator' + RegexSetId: + description: 正则表达式Id, 目前只读 + type: string + RuleGroupId: + description: 自定义规则组Id, 目前只读 + type: string + SearchString: + description: 搜索字段, 仅Aws有用 + type: string + Transformations: + $ref: '#/definitions/TextTransformations' + Type: + $ref: '#/definitions/TWafStatementType' + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SZoneQuotaDetail: + description: 可用区配额详情 + properties: + account: + description: 配额适用的云账号名称 + type: string + x-go-name: Account + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + manager: + description: 配额适用的云订阅名称 + type: string + x-go-name: Manager + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region: + description: 配额适用的区域名称 + type: string + x-go-name: Region + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone: + description: 配额适用的可用区名称 + type: string + x-go-name: Zone + zone_id: + description: 配额适用的可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + ScalingActivityDetails: + properties: + action_desc: + description: 行为描述 + type: string + x-go-name: ActionDesc + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + end_time: + format: date-time + type: string + x-go-name: EndTime + id: + description: 资源UUID + type: string + x-go-name: Id + instance_number: + format: int64 + type: integer + x-go-name: InstanceNumber + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + reason: + type: string + x-go-name: Reason + scaling_group: + description: 'description: 伸缩组名称' + example: sg-nihao + type: string + x-go-name: ScalingGroup + scaling_group_id: + description: ScalingGroupId + example: sg-1234 + type: string + x-go-name: ScalingGroupId + start_time: + format: date-time + type: string + x-go-name: StartTime + status: + description: 资源状态 + type: string + x-go-name: Status + trigger_desc: + description: 起因描述 + type: string + x-go-name: TriggerDesc + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingAlarmCreateInput: + properties: + cumulate: + description: 'description: 累计次数(报警次数达到此累计次数就会触发伸缩活动)' + example: 1 + format: int64 + type: integer + x-go-name: Cumulate + cycle: + description: 'description: 监控周期，单位s' + example: 300 + format: int64 + type: integer + x-go-name: Cycle + indicator: + description: 'description: 监控指标' + enum: + - cpu + - disk_read + - disk_write + - flow_into + - flow_out + example: cpu + type: string + x-go-name: Indicator + operator: + description: 'descripion: 监控指标的比较符' + enum: + - ge + - le + example: ge + type: string + x-go-name: Operator + value: + description: 'description: 监控指标的取值' + example: 3 + format: double + type: number + x-go-name: Value + wrapper: + description: 'description: 监控指标的取值方式(比如最大值，最小值，平均值)' + enum: + - max + - min + - average + example: max + type: string + x-go-name: Wrapper + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingAlarmDetails: + properties: + cumulate: + description: 'description: 累计次数，只有到达累计次数的报警才会触发伸缩活动' + format: int64 + type: integer + x-go-name: Cumulate + cycle: + description: 'description: 监控周期' + format: int64 + type: integer + x-go-name: Cycle + indicator: + description: 'description: 指标' + type: string + x-go-name: Indicator + operator: + description: 'description: 指标和阈值之间的比较关系，>=/<=' + type: string + x-go-name: Operator + value: + description: 'description: 阈值' + format: double + type: number + x-go-name: Value + wrapper: + description: 'description: 指标的取值方式，最大值/最小值/平均值' + type: string + x-go-name: Wrapper + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingGroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + backend_group_id: + description: 'swagger: ignore' + type: string + x-go-name: BackendGroupId + cloudregion: + description: 'description: cloud region id or name' + example: cr-test-one + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 'swagger: ignore' + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + desire_instance_number: + description: 'description: 期望实例数' + example: 1 + format: int64 + type: integer + x-go-name: DesireInstanceNumber + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + expansion_principle: + description: 'description: 扩容策略' + enum: + - balanced + example: balanced + type: string + x-go-name: ExpansionPrinciple + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + guest_template: + description: 'description: 主机模板 id or name' + example: gt-test-one + type: string + x-go-name: GuestTemplate + guest_template_id: + description: 'swagger: ignore' + type: string + x-go-name: GuestTemplateId + health_check_cycle: + description: 'description: 健康检查周期' + example: 300 + format: int64 + type: integer + x-go-name: HealthCheckCycle + health_check_gov: + description: 'description: 健康检查缓冲时间' + example: 180 + format: int64 + type: integer + x-go-name: HealthCheckGov + health_check_mode: + description: 'description: 检查健康模式' + enum: + - normal + - loadbalancer + example: normal + type: string + x-go-name: HealthCheckMode + hypervisor: + description: 'description: hypervisor' + example: kvm + type: string + x-go-name: Hypervisor + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + lb_backend_group: + description: 'description: 负载均衡后端服务器组' + example: lbg-nihao + type: string + x-go-name: LbBackendGroup + loadbalancer_backend_port: + description: 'description: 负载均衡后端服务器统一端口' + example: 8080 + format: int64 + type: integer + x-go-name: LoadbalancerBackendPort + loadbalancer_backend_weight: + description: 'description: 负载均衡后端服务器的weight' + example: 10 + format: int64 + type: integer + x-go-name: LoadbalancerBackendWeight + max_instance_number: + description: 'description: 最大实例数' + example: 10 + format: int64 + type: integer + x-go-name: MaxInstanceNumber + min_instance_number: + description: 'description: 最小实例数' + example: 0 + format: int64 + type: integer + x-go-name: MinInstanceNumber + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + networks: + description: 'description: 多个网络(ID或者Name),' + example: n-test-one + items: + type: string + type: array + x-go-name: Networks + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + shrink_principle: + description: 'description: 缩容策略' + enum: + - earliest + - latest + - config_earliest + - config_latest + example: latest + type: string + x-go-name: ShrinkPrinciple + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + required: + - name + - cloudregion + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingGroupDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + backend_group: + description: 负载均衡后端组名称 + type: string + x-go-name: BackendGroup + backend_group_id: + description: 负载均衡后端组ID + type: string + x-go-name: BackendGroupId + brand: + description: 'description: 平台' + example: OneCloud + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + desire_instance_number: + description: |- + DesireInstanceNumber represent the number of instances that should exist in the scaling group. + Scaling controller will monitor and ensure this in real time. + Scaling activities triggered by various policies will also modify this value. + This value should between MinInstanceNumber and MaxInstanceNumber + format: int64 + type: integer + x-go-name: DesireInstanceNumber + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + expansion_principle: + description: ExpansionPrinciple represent the principle when creating new + instance to join in. + type: string + x-go-name: ExpansionPrinciple + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + group: + description: 实例组名称 + type: string + x-go-name: Group + group_id: + description: 实例组ID + type: string + x-go-name: GroupId + guest_template: + description: 主机模板名称 + type: string + x-go-name: GuestTemplate + guest_template_id: + description: 主机模板ID + type: string + x-go-name: GuestTemplateId + health_check_cycle: + format: int64 + type: integer + x-go-name: HealthCheckCycle + health_check_gov: + format: int64 + type: integer + x-go-name: HealthCheckGov + health_check_mode: + type: string + x-go-name: HealthCheckMode + hypervisor: + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + instance_number: + description: 'description: 实例数' + example: 0 + format: int64 + type: integer + x-go-name: InstanceNumber + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + loadbalancer: + description: 负载均衡名称 + type: string + x-go-name: Loadbalancer + loadbalancer_backend_port: + format: int64 + type: integer + x-go-name: LoadbalancerBackendPort + loadbalancer_backend_weight: + format: int64 + type: integer + x-go-name: LoadbalancerBackendWeight + loadbalancer_id: + description: 负载均衡ID + type: string + x-go-name: LoadbalancerId + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + max_instance_number: + format: int64 + type: integer + x-go-name: MaxInstanceNumber + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + min_instance_number: + format: int64 + type: integer + x-go-name: MinInstanceNumber + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + description: 'description: 网络信息' + items: + $ref: '#/definitions/ScalingGroupNetwork' + type: array + x-go-name: Networks + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + scaling_policy_number: + description: 'description: 伸缩策略的数量' + example: 3 + format: int64 + type: integer + x-go-name: ScalingPolicyNumber + shrink_principle: + description: ShrinkPrinciple represent the principle when removing instance + from scaling group. + type: string + x-go-name: ShrinkPrinciple + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + description: VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingGroupNetwork: + properties: + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_start: + type: string + x-go-name: GuestIpStart + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingPolicyCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + action: + description: 'desciption: 伸缩策略的行为(增加还是删除或者调整为)' + enum: + - add + - remove + - set + example: add + type: string + x-go-name: Action + alarm: + $ref: '#/definitions/ScalingAlarmCreateInput' + cooling_time: + description: 'desciption: Scaling activity triggered by alarms will be rejected + during this period about CoolingTime' + example: 300 + format: int64 + type: integer + x-go-name: CoolingTime + cycle_timer: + $ref: '#/definitions/CycleTimerCreateInput' + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + number: + description: 'desciption: 实例的数量' + example: 2 + format: int64 + type: integer + x-go-name: Number + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + scaling_group: + description: 'description: scaling_group ID or Name' + example: sg-test-one + type: string + x-go-name: ScalingGroup + scaling_group_id: + description: 'swagger: ignore' + type: string + x-go-name: ScalingGroupId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + timer: + $ref: '#/definitions/TimerCreateInput' + trigger_type: + description: 'description: trigger type' + enum: + - timing + - cycle + - alarm + type: string + x-go-name: TriggerType + unit: + description: 'desciption: 实例数量的单位' + enum: + - s + - '%' + example: s + type: string + x-go-name: Unit + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ScalingPolicyDetails: + properties: + action: + description: Action of scaling activity + type: string + x-go-name: Action + alarm: + $ref: '#/definitions/ScalingAlarmDetails' + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cooling_time: + description: Scaling activity triggered by alarms will be rejected during + this period about CoolingTime + format: int64 + type: integer + x-go-name: CoolingTime + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + cycle_timer: + $ref: '#/definitions/CycleTimerDetails' + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + number: + format: int64 + type: integer + x-go-name: Number + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + scaling_group: + description: 'description: 伸缩组名称' + example: sg-nihao + type: string + x-go-name: ScalingGroup + scaling_group_id: + description: ScalingGroupId + example: sg-1234 + type: string + x-go-name: ScalingGroupId + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + timer: + $ref: '#/definitions/TimerDetails' + trigger_id: + type: string + x-go-name: TriggerId + trigger_type: + type: string + x-go-name: TriggerType + unit: + description: Unit of Number + type: string + x-go-name: Unit + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedpolicyDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + condition: + type: string + x-go-name: Condition + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + enabled: + type: boolean + x-go-name: Enabled + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + resource_type: + description: 调度标签管理的资源类型 + type: string + x-go-name: ResourceType + schedtag: + description: 调度标签名称 + type: string + x-go-name: Schedtag + schedtag_id: + description: 归属调度标签ID + type: string + x-go-name: SchedtagId + strategy: + type: string + x-go-name: Strategy + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedtagConfig: + properties: + id: + type: string + x-go-name: Id + resource_type: + type: string + x-go-name: ResourceType + strategy: + type: string + x-go-name: Strategy + weight: + format: int64 + type: integer + x-go-name: Weight + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedtagCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + default_strategy: + description: 动态标签策略 + enum: + - exclude + - ' prefer' + - ' avoid' + type: string + x-go-name: DefaultStrategy + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + resource_type: + default: hosts + description: 资源类型 + enum: + - servers + - ' hosts' + - ' .....' + type: string + x-go-name: ResourceType + scope: + type: string + x-go-name: Scope + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedtagDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + default_strategy: + type: string + x-go-name: DefaultStrategy + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + dynamic_schedtag_count: + format: int64 + type: integer + x-go-name: DynamicSchedtagCount + host_count: + format: int64 + type: integer + x-go-name: HostCount + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + join_model_keyword: + type: string + x-go-name: JoinModelKeyword + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + other_count: + format: int64 + type: integer + x-go-name: OtherCount + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + resource_count: + format: int64 + type: integer + x-go-name: ResourceCount + resource_type: + description: Column(VARCHAR(16, charset='ascii'), nullable=True, default='') + type: string + x-go-name: ResourceType + schedpolicy_count: + format: int64 + type: integer + x-go-name: SchedpolicyCount + scope: + type: string + x-go-name: Scope + server_count: + format: int64 + type: integer + x-go-name: ServerCount + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedtagSetResourceInput: + properties: + resource_ids: + items: + type: string + type: array + x-go-name: ResourceIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SchedtagShortDescDetails: + properties: + default: + type: string + x-go-name: Default + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + res_name: + type: string + x-go-name: ResName + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecgroupDetails: + properties: + admin_guest_cnt: + description: admin_secgrp_id为此安全组的云主机数量, , 不包含回收站云主机 + format: int64 + type: integer + x-go-name: AdminGuestCnt + cache_cnt: + description: 安全组缓存数量 + format: int64 + type: integer + x-go-name: CacheCnt + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + guest_cnt: + description: 关联云主机数量, 不包含回收站云主机 + format: int64 + type: integer + x-go-name: GuestCnt + id: + description: 资源UUID + type: string + x-go-name: Id + in_rules: + description: 入方向规则信息 + items: + $ref: '#/definitions/SecgroupRuleDetails' + type: array + x-go-name: InRules + is_dirty: + type: boolean + x-go-name: IsDirty + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + out_rules: + description: 出方向规则信息 + items: + $ref: '#/definitions/SecgroupRuleDetails' + type: array + x-go-name: OutRules + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + rules: + description: 规则信息 + items: + $ref: '#/definitions/SecgroupRuleDetails' + type: array + x-go-name: Rules + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + system_guest_cnt: + description: 关联此安全组的云主机is_system为true数量, , 不包含回收站云主机 + format: int64 + type: integer + x-go-name: SystemGuestCnt + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + total_cnt: + description: 所有关联的资源数量 + format: int64 + type: integer + x-go-name: TotalCnt + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecgroupImportRulesInput: + properties: + rules: + items: + $ref: '#/definitions/SSecgroupRuleCreateInput' + type: array + x-go-name: Rules + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecgroupMergeInput: + properties: + secgroup_ids: + description: 安全组id列表 + items: + type: string + type: array + x-go-name: SecgroupIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecgroupRuleDetails: + properties: + action: + type: string + x-go-name: Action + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cidr: + type: string + x-go-name: CIDR + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + type: string + x-go-name: Description + direction: + type: string + x-go-name: Direction + id: + type: string + x-go-name: Id + ports: + type: string + x-go-name: Ports + priority: + format: int64 + type: integer + x-go-name: Priority + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + protocol: + type: string + x-go-name: Protocol + secgroup: + description: 安全组名称 + type: string + x-go-name: Secgroup + secgroup_id: + description: 本地安全组ID + type: string + x-go-name: SecgroupId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecurityGroupCacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + external_project_id: + type: string + x-go-name: ExternalProjectId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + reference_count: + description: 被其他安全组引用的次数 + format: int64 + type: integer + x-go-name: ReferenceCount + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + secgroup_id: + description: 本地安全组ID + type: string + x-go-name: SecgroupId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: 虚拟私有网络名称 + type: string + x-go-name: Vpc + vpc_id: + description: 虚拟私有网络外部Id + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecurityGroupCacheInput: + properties: + vpc_id: + type: string + x-go-name: VpcId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecurityGroupCloneInput: + properties: + Description: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SecurityGroupReference: + properties: + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + ServerAssociateEipInput: + properties: + eip_id: + description: 弹性公网IP的ID + type: string + x-go-name: EipId + ip_addr: + description: 弹性IP映射的内网IP地址，可选 + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerAttachDiskInput: + properties: + boot_index: + format: int8 + type: integer + x-go-name: BootIndex + disk_id: + type: string + x-go-name: DiskId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCPUSetInput: + properties: + cpus: + description: Specifies the CPUs that tasks in this cgroup are permitted to + access. + items: + format: int64 + type: integer + type: array + x-go-name: CPUS + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCPUSetRemoveInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCPUSetRemoveResp: + properties: + done: + type: boolean + x-go-name: Done + error: + type: string + x-go-name: Error + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerChangeConfigInput: + properties: + auto_start: + description: 调整完配置后是否自动启动 + type: boolean + x-go-name: AutoStart + disks: + items: + $ref: '#/definitions/DiskConfig' + type: array + x-go-name: Disks + flavor: + description: 'swagger: ignore' + type: string + x-go-name: Flavor + instance_type: + description: |- + 关机且停机不收费情况下不允许调整配置 + 实例类型, 优先级高于vcpu_count和vmem_size + type: string + x-go-name: InstanceType + sku: + description: 'swagger: ignore' + type: string + x-go-name: Sku + vcpu_count: + description: cpu大小 + format: int64 + type: integer + x-go-name: VcpuCount + vmem_size: + description: 内存大小, 1024M, 1G + type: string + x-go-name: VmemSize + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerChangeDiskStorageInput: + properties: + disk_id: + type: string + x-go-name: DiskId + keep_origin_disk: + type: boolean + x-go-name: KeepOriginDisk + target_storage_id: + type: string + x-go-name: TargetStorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerChangeStorageInput: + properties: + keep_origin_disk: + type: boolean + x-go-name: KeepOriginDisk + target_storage_id: + type: string + x-go-name: TargetStorageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCreateEipInput: + properties: + auto_dellocate: + description: auto_dellocate + type: boolean + x-go-name: AutoDellocate + bandwidth: + description: Bandwidth + format: int64 + type: integer + x-go-name: Bandwidth + bgp_type: + description: bgp_type + type: string + x-go-name: BgpType + charge_type: + description: 计费方式，traffic or bandwidth + type: string + x-go-name: ChargeType + ip_addr: + description: 弹性IP映射的内网IP地址，可选 + type: string + x-go-name: IpAddr + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + __parent_task_id: + description: Used to store BaremetalConvertHypervisorTaskId + type: string + x-go-name: ParentTaskId + auto_renew: + default: false + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + auto_start: + default: false + description: |- + 创建后自动启动 + 部分云创建后会自动启动例如: 腾讯云, AWS, OpenStack, ZStack, Ucloud, Huawei, Azure, 天翼云 + type: boolean + x-go-name: AutoStart + backup: + default: false + description: 虚拟机高可用(创建备机) + type: boolean + x-go-name: Backup + baremetal_disk_configs: + description: 裸金属磁盘配置列表 + items: + $ref: '#/definitions/BaremetalDiskConfig' + type: array + x-go-name: BaremetalDiskConfigs + bios: + description: |- + BIOS类型, 若镜像是Windows，并且支持UEFI,则自动会设置为UEFI + emulate: BIOS, UEFI + type: string + x-go-name: Bios + boot_order: + default: cdn + description: |- + 启动顺序 + c: cdrome + d: disk + n: network + example: cnd + type: string + x-go-name: BootOrder + cdrom: + description: 使用ISO光盘启动, 仅KVM平台支持 + type: string + x-go-name: Cdrom + cdrom_boot_index: + format: int8 + type: integer + x-go-name: CdromBootIndex + deploy_configs: + items: + $ref: '#/definitions/DeployConfig' + type: array + x-go-name: DeployConfigs + deploy_telegraf: + type: boolean + x-go-name: DeployTelegraf + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disable_delete: + default: true + description: 删除保护,创建的资源默认不允许删除 + type: boolean + x-go-name: DisableDelete + disks: + description: |- + 磁盘列表,第一块磁盘为系统盘,需要指定image_id + 若指定主机快照，此参数可以为空 + items: + $ref: '#/definitions/DiskConfig' + type: array + x-go-name: Disks + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + duration: + description: |- + 包年包月时长 + + + 平台 |是否支持 | + ---- |------- | + KVM |否 | + ESxi |否 | + OpenStack |否 | + ZStack |否 | + Google |否 | + Azure |否 | + AWS |否 | + 腾讯云 |是 | + Aliyun |是 | + Ucloud |是 | + Huawei |是 | + 天翼云 |是 | + type: string + x-go-name: Duration + eip: + description: |- + 弹性公网IP名称或ID + 绑定已有弹性公网IP, 此参数会限制虚拟机再谈下公网IP所在的区域创建 + type: string + x-go-name: Eip + eip_auto_dellocate: + description: 是否跟随主机删除而自动释放 + type: boolean + x-go-name: EipAutoDellocate + eip_bgp_type: + description: 弹性公网IP线路类型 + type: string + x-go-name: EipBgpType + eip_bw: + description: |- + 弹性公网IP带宽 + 指定此参数后会创建新的弹性公网IP并绑定到新建的虚拟机 + 此参数优先级低于public_ip + format: int64 + type: integer + x-go-name: EipBw + eip_charge_type: + description: 弹性公网IP计费类型 + type: string + x-go-name: EipChargeType + enable_cloud_init: + default: false + description: 启用cloud-init,需要镜像装有cloud-init服务 + type: boolean + x-go-name: EnableCloudInit + enable_memclean: + type: boolean + x-go-name: EnableMemclean + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + fake_create: + description: |- + swagger: ignore + 创建测试数据，不实际创建资源 + type: boolean + x-go-name: FakeCreate + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + groups: + description: 主机组列表, 参数可以是主机组名称或ID,建议使用ID + items: + type: string + type: array + x-go-name: InstanceGroupIds + guest_image_id: + description: 指定用于新建主机的主机镜像ID + type: string + x-go-name: GuestImageID + hostname: + description: |- + 主机名 + 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 + 字符长度2-60个字符 + Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 + 若输入为空，则会根据资源名称自动生成主机名 + 输入不为空则会自动剔除不符合规则的字符, 并进行校验 + 若长度大于允许的最大长度，会自动截取 + type: string + x-go-name: Hostname + hypervisor: + default: kvm + description: |- + 虚拟化技术或平台 + + + + hypervisor | 技术或平台 | + ------- | ---------- | + kvm | 本地私有云 | + esxi | VMWare | + baremetal | 裸金属 | + aliyun | 阿里云 | + aws | 亚马逊 | + qcloud | 腾讯云 | + azure | 微软云 | + huawei | 华为云 | + openstack | OpenStack | + ucloud | Ucloud | + zstack | ZStack | + google | 谷歌云 | + ctyun | 天翼云 | + type: string + x-go-name: Hypervisor + instance_backup_id: + description: |- + 使用主机备份创建虚拟机, 主机快照不会重置密码及秘钥信息 + 使用主机备份创建的虚拟机将沿用之前的密码秘钥及安全组信息 + type: string + x-go-name: InstanceBackupId + instance_snapshot_id: + description: |- + 使用主机快照创建虚拟机, 主机快照不会重置密码及秘钥信息 + 使用主机快照创建的虚拟机将沿用之前的密码秘钥及安全组信息 + type: string + x-go-name: InstanceSnapshotId + instance_type: + description: |- + 套餐名称, 此参数优先级高于vcpu_count和vmem_size + 套餐可以通过 serverskus 列表获取 + esxi, openstack, zstack等私有云都统一使用provider为OneCloud的套餐 + 公有云使用各自的套餐 + type: string + x-go-name: InstanceType + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + isolated_devices: + description: 透传设备列表 + items: + $ref: '#/definitions/IsolatedDeviceConfig' + type: array + x-go-name: IsolatedDevices + keypair_id: + description: 秘钥对Id + type: string + x-go-name: KeypairId + login_account: + description: 登录账户 + type: string + x-go-name: LoginAccount + machine: + description: |- + Machine类型 + emulate: pc, q35 + type: string + x-go-name: Machine + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + nets: + description: 指定主机网络 + items: + $ref: '#/definitions/NetworkConfig' + type: array + x-go-name: Networks + password: + description: |- + 密码 + 要求: 密码长度 >= 20, 至少包含一个数字一个小写字母一个大小字母及特殊字符~`!@#$%^&*()-_=+[]{}|:';\",./<>?中的一个 + requried: false + type: string + x-go-name: Password + prefer_backup_host: + description: 主机高可用时，将备机调度到指定宿主机, 此参数仅对KVM生效 + type: string + x-go-name: PreferBackupHost + prefer_host_id: + description: 调度使用指定宿主机 + type: string + x-go-name: PreferHost + prefer_manager_id: + description: 调度使用指定的云账号 + type: string + x-go-name: PreferManager + prefer_region_id: + description: 调度到指定区域,优先级低于prefer_zone_id + type: string + x-go-name: PreferRegion + prefer_wire_id: + description: 调度使用指定二层网络, 优先级低于prefer_host_id + type: string + x-go-name: PreferWire + prefer_zone_id: + description: 调度到指定可用区,优先级低于prefer_host_id + type: string + x-go-name: PreferZone + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_ip_bw: + description: |- + 公网IP带宽(单位MB) + 若指定此参数则忽略eip相关参数 + 私有云不支持此参数 + + + 平台 |支持范围 | + ---- |------- | + 腾讯云 |按量计费1-100, 包年包月1-200 | + format: int64 + type: integer + x-go-name: PublicIpBw + public_ip_charge_type: + description: |- + 公网IP计费类型 + 默认按流量计费 + + + 类别 |说明 | + ---- |------- | + traffic |按流量计费| + bandwidth |按带宽计费| + type: string + x-go-name: PublicIpChargeType + reset_password: + description: |- + 随机密码, 若指定password参数,此参数不生效 + 若值为false并且password为空,则表示保留镜像密码 + type: boolean + x-go-name: ResetPassword + schedtags: + description: 调度标签 + items: + $ref: '#/definitions/SchedtagConfig' + type: array + x-go-name: Schedtags + secgroups: + description: 安全组Id列表 + items: + type: string + type: array + x-go-name: Secgroups + secgrp_id: + description: 安全组Id, 此参数会和secgroups参数合并 + type: string + x-go-name: SecgroupId + shutdown_behavior: + default: stop + description: |- + 关机后执行的操作 + terminate: 关机后自动删除 + emum: stop, terminate + type: string + x-go-name: ShutdownBehavior + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + suggestion: + description: DEPRECATE + type: boolean + x-go-name: Suggestion + user_data: + description: |- + 用户自定义启动脚本 + 部分平台只支持 #cloud-config yaml 格式(由于部分平台密码依赖cloud-init注入密码信息,所以不支持特殊类型的user data) + 支持特殊user data平台: Aliyun, Qcloud, Azure, Apsara, Ucloud + type: string + x-go-name: UserData + vcpu_count: + default: 1 + description: 虚拟机Cpu大小,若未指定instance_type,此参数为必传项 + format: int64 + type: integer + x-go-name: VcpuCount + vdi: + default: vnc + description: 远程连接协议 + enum: + - vnc + - ' spice' + type: string + x-go-name: Vdi + vga: + default: std + enum: + - cirros + - ' vmware' + - ' qxl' + - ' std' + type: string + x-go-name: Vga + vmem_size: + description: 虚拟机内存大小,单位Mb,若未指定instance_type,此参数为必传项 + format: int64 + type: integer + x-go-name: VmemSize + required: + - name + - disks + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDelExtraOptionInput: + properties: + key: + type: string + x-go-name: Key + value: + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDeployInput: + properties: + __delete_keypair__: + description: 解绑当前虚拟机秘钥, 并清理公钥信息 + type: boolean + x-go-name: DeleteKeypair + auto_start: + description: |- + 部署完成后是否自动启动 + 若虚拟机重置密码后需要重启生效，并且当前虚拟机状态为running, 此参数默认为true + 若虚拟机状态为ready, 指定此参数后，部署完成后，虚拟机会自动启动 + type: boolean + x-go-name: AutoStart + delete_public_key: + description: |- + 清理指定公钥 + 若指定的秘钥Id和虚拟机的秘钥Id不相同, 则清理旧的公钥 + type: string + x-go-name: DeletePublicKey + deploy_configs: + description: 'swagger: ignore' + items: + $ref: '#/definitions/DeployConfig' + type: array + x-go-name: DeployConfigs + deploy_telegraf: + description: 'swagger: ignore' + type: boolean + x-go-name: DeployTelegraf + keypair: + description: 'swagger: ignore' + type: string + x-go-name: Keypair + keypair_id: + description: 秘钥Id + type: string + x-go-name: KeypairId + password: + description: 重置指定密码 + type: string + x-go-name: Password + reset_password: + description: 生成随机密码, 优先级低于password + type: boolean + x-go-name: ResetPassword + restart: + description: 'swagger: ignore' + type: boolean + x-go-name: Restart + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDetachDiskInput: + properties: + disk_id: + description: 磁盘Id，若磁盘未挂载在虚拟机上，不返回错误 + type: string + x-go-name: DiskId + keep_disk: + default: false + description: 是否保留磁盘 + type: boolean + x-go-name: KeepDisk + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDetachnetworkInput: + properties: + ip_addr: + description: 通过IP解绑网卡, 优先级高于mac + type: string + x-go-name: IpAddr + mac: + description: 通过Mac解绑网卡, 优先级低于ip_addr + type: string + x-go-name: Mac + net_id: + description: 通过IP子网地址, 优先级最高 + type: string + x-go-name: NetId + reserve: + description: 是否保留IP地址(ip地址会进入到预留ip) + type: boolean + x-go-name: Reserve + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + admin_secgrp_id: + description: 管理员可见安全组Id + type: string + x-go-name: AdminSecgrpId + admin_security_rules: + description: 系统管理员可见的安全组规则 + type: string + x-go-name: AdminSecurityRules + attach_time: + description: list + format: date-time + type: string + x-go-name: AttachTime + auto_delete_at: + description: 自动释放时间 + format: date-time + type: string + x-go-name: AutoDeleteAt + auto_renew: + description: 是否自动续费 + type: boolean + x-go-name: AutoRenew + backup_guest_status: + type: string + x-go-name: BackupGuestStatus + backup_guest_sync_status: + description: 主备机同步状态 + type: string + x-go-name: BackupGuestSyncStatus + backup_host_id: + description: 备份机所在宿主机Id + type: string + x-go-name: BackupHostId + backup_host_name: + description: 备份主机所在宿主机名称 + type: string + x-go-name: BackupHostName + backup_host_status: + description: 备份主机所在宿主机状态 + type: string + x-go-name: BackupHostStatus + billing_cycle: + description: 计费周期 + type: string + x-go-name: BillingCycle + billing_type: + description: 计费类型, 按量、包年包月 + example: postpaid + type: string + x-go-name: BillingType + bios: + type: string + x-go-name: Bios + boot_order: + description: 启动顺序 + type: string + x-go-name: BootOrder + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_recycle: + description: 是否可以回收 + type: boolean + x-go-name: CanRecycle + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cdrom: + description: Cdrom信息 + items: + $ref: '#/definitions/Cdrom' + type: array + x-go-name: Cdrom + cdrom_support: + description: 是否支持ISO启动 + type: boolean + x-go-name: CdromSupport + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + description: 是否开启删除保护 + example: true + type: boolean + x-go-name: DisableDelete + disk: + description: 磁盘大小 + example: 30720 + format: int64 + type: integer + x-go-name: DiskSizeMb + disk_count: + description: 磁盘数量 + format: int64 + type: integer + x-go-name: DiskCount + disks: + description: 磁盘概要 + type: string + x-go-name: Disks + disks_info: + description: 磁盘详情 + items: + $ref: '#/definitions/GuestDiskInfo' + type: array + x-go-name: DisksInfo + domain_id: + description: 域Id + type: string + x-go-name: DomainId + eip: + description: 浮动IP + type: string + x-go-name: Eip + eip_mode: + description: 浮动IP类型 + type: string + x-go-name: EipMode + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + description: 过期时间 + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + flavor_id: + type: string + x-go-name: FlavorId + floppy: + description: Floppy信息 + items: + $ref: '#/definitions/Floppy' + type: array + x-go-name: Floppy + floppy_support: + description: 是否支持Floppy启动 + type: boolean + x-go-name: FloppySupport + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + host: + description: 宿主机名称 + type: string + x-go-name: Host + host_enabled: + description: 宿主是否启用 + type: boolean + x-go-name: HostEnabled + host_id: + type: string + x-go-name: HostId + host_service_status: + description: 宿主机服务状态` + type: string + x-go-name: HostServiceStatus + host_sn: + description: 宿主机序列号 + type: string + x-go-name: HostSN + host_status: + description: 宿主机状态 + type: string + x-go-name: HostStatus + host_type: + description: 宿主机类型 + type: string + x-go-name: HostType + hostname: + type: string + x-go-name: Hostname + hypervisor: + description: 虚拟化技术 + example: kvm + type: string + x-go-name: Hypervisor + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type: + description: 套餐名称 + type: string + x-go-name: InstanceType + internet_max_bandwidth_out: + description: 最大内网带宽 + format: int64 + type: integer + x-go-name: InternetMaxBandwidthOut + ips: + description: IP地址列表字符串 + example: 10.165.2.1,172.16.8.1 + type: string + x-go-name: IPs + is_daemon: + type: boolean + x-go-name: IsDaemon + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_gpu: + description: 是否支持GPU + type: boolean + x-go-name: IsGpu + is_prepaid_recycle: + description: common + type: boolean + x-go-name: IsPrepaidRecycle + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + isolated_devices: + description: 直通设备（GPU）列表 + items: + $ref: '#/definitions/SIsolatedDevice' + type: array + x-go-name: IsolatedDevices + keypair: + description: 密钥对 + type: string + x-go-name: Keypair + keypair_id: + description: 秘钥对Id + type: string + x-go-name: KeypairId + machine: + type: string + x-go-name: Machine + macs: + description: mac地址信息 + type: string + x-go-name: Macs + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + monitor_url: + description: 监控上报URL + type: string + x-go-name: MonitorUrl + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + description: |- + details + 网络概要 + type: string + x-go-name: Networks + nics: + description: 网卡信息 + items: + $ref: '#/definitions/GuestnetworkShortDesc' + type: array + x-go-name: Nics + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + os_name: + description: 操作系统名称 + type: string + x-go-name: OsName + os_type: + description: 操作系统类型 + type: string + x-go-name: OsType + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + power_states: + description: power_states limit in [on, off, unknown] + type: string + x-go-name: PowerStates + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + progress_mbps: + description: 迁移或克隆的速度 + format: double + type: number + x-go-name: ProgressMbps + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + qga_status: + type: string + x-go-name: QgaStatus + record_checksum: + type: string + x-go-name: RecordChecksum + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + scaling_group_id: + description: 伸缩组id + type: string + x-go-name: ScalingGroupId + scaling_status: + description: 主机在伸缩组中的状态 + type: string + x-go-name: ScalingStatus + secgroup: + description: 关联主安全组 + type: string + x-go-name: Secgroup + secgroups: + description: 关联安全组列表 + items: + $ref: '#/definitions/StandaloneShortDesc' + type: array + x-go-name: Secgroups + secgrp_id: + description: 安全组Id + example: default + type: string + x-go-name: SecgrpId + security_rules: + description: 安全组规则 + type: string + x-go-name: SecurityRules + shutdown_behavior: + description: 关机操作类型 + example: stop + type: string + x-go-name: ShutdownBehavior + shutdown_mode: + description: 关机收费模式 + example: keep_charging, stop_charging + type: string + x-go-name: ShutdownMode + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + src_ip_check: + type: boolean + x-go-name: SrcIpCheck + src_mac_check: + type: boolean + x-go-name: SrcMacCheck + sshable_last_state: + type: boolean + x-go-name: SshableLastState + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + throughput: + description: 磁盘吞吐量 + format: int64 + type: integer + x-go-name: Throughput + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vcpu_count: + description: CPU大小 + format: int64 + type: integer + x-go-name: VcpuCount + vdi: + type: string + x-go-name: Vdi + vga: + type: string + x-go-name: Vga + vip: + description: VIP + type: string + x-go-name: Vip + vip_eip: + description: VIP's eip + type: string + x-go-name: VipEip + virtual_ips: + description: 虚拟机Ip列表 + type: string + x-go-name: VirtualIps + vmem_size: + description: 内存大小, 单位Mb + format: int64 + type: integer + x-go-name: VmemSize + vpc: + description: 归属VPC + type: string + x-go-name: Vpc + vpc_external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: VpcExternalAccessMode + vpc_id: + description: 归属VPC ID + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + description: 归属可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerDissociateEipInput: + properties: + auto_delete: + description: 是否自动释放 + type: boolean + x-go-name: AudoDelete + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerEjectVfdInput: + properties: + floppy_ordinal: + format: int64 + type: integer + x-go-name: FloppyOrdinal + image_id: + type: string + x-go-name: ImageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerGetCPUSetCoresResp: + properties: + host_cores: + items: + format: int64 + type: integer + type: array + x-go-name: HostCores + host_used_cores: + items: + format: int64 + type: integer + type: array + x-go-name: HostUsedCores + pinned_cores: + items: + format: int64 + type: integer + type: array + x-go-name: PinnedCores + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerInsertVfdInput: + properties: + floppy_ordinal: + format: int64 + type: integer + x-go-name: FloppyOrdinal + image_id: + type: string + x-go-name: ImageId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerInstanceSnapshot: + properties: + generate_name: + type: string + x-go-name: GenerateName + name: + type: string + x-go-name: Name + with_memory: + type: boolean + x-go-name: WithMemory + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerMigrateForecastInput: + properties: + convert_to_kvm: + type: boolean + x-go-name: ConvertToKvm + is_rescue_mode: + type: boolean + x-go-name: IsRescueMode + live_migrate: + type: boolean + x-go-name: LiveMigrate + prefer_host: + description: Deprecated + type: string + x-go-name: PreferHost + prefer_host_id: + type: string + x-go-name: PreferHostId + skip_cpu_check: + type: boolean + x-go-name: SkipCpuCheck + skip_kernel_check: + type: boolean + x-go-name: SkipKernelCheck + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerMigrateNetworkInput: + properties: + dest: + description: Destination network Id + type: string + x-go-name: Dest + src: + description: Source network Id + type: string + x-go-name: Src + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerMonitorInput: + properties: + COMMAND: + type: string + QMP: + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQemuInfo: + properties: + cmdline: + type: string + x-go-name: Cmdline + version: + type: string + x-go-name: Version + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQgaCommandInput: + properties: + Command: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerQgaSetPasswordInput: + properties: + Password: + type: string + Username: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerRebuildRootInput: + properties: + all_disks: + type: boolean + x-go-name: AllDisks + auto_start: + type: boolean + x-go-name: AutoStart + image: + description: 'swagger: ignore' + type: string + x-go-name: Image + image_id: + description: |- + 关机且停机不收费情况下不允许重装系统 + 镜像 id + type: string + x-go-name: ImageId + keypair: + description: 'swagger: ignore' + type: string + x-go-name: Keypair + keypair_id: + description: 秘钥Id + type: string + x-go-name: KeypairId + password: + type: string + x-go-name: Password + reset_password: + type: boolean + x-go-name: ResetPassword + required: + - image_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerRemoteUpdateInput: + properties: + replace_tags: + description: 是否覆盖替换所有标签 + type: boolean + x-go-name: ReplaceTags + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerResetInput: + properties: + auto_start: + description: 自动启动 + type: boolean + x-go-name: AutoStart + instance_snapshot: + type: string + x-go-name: InstanceSnapshot + with_memory: + description: 恢复内存 + type: boolean + x-go-name: WithMemory + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerResizeDiskInput: + properties: + disk: + description: 'swagger: ignore' + type: string + x-go-name: Disk + disk_id: + description: 磁盘Id + type: string + x-go-name: DiskId + size: + description: 'default unit: Mb' + example: 1024; 40G; 1024M + type: string + x-go-name: Size + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerResumeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSaveGuestImageInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + auto_start: + description: 保存镜像后是否自动启动 + type: boolean + x-go-name: AutoStart + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_format: + description: 镜像格式 + type: string + x-go-name: DiskFormat + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + notes: + description: 备注 + type: string + x-go-name: Notes + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + protected: + description: 是否有删除保护 + type: boolean + x-go-name: Protected + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSaveImageInput: + properties: + AutoStart: + default: false + description: |- + 保存镜像后是否自动启动,若实例状态为运行中,则会先关闭实例 + 公有云若支持开机保存镜像，此参数则不生效 + type: boolean + Format: + description: 镜像格式 + type: string + GenerateName: + type: string + ImageId: + description: 'swagger: ignore' + type: string + IsPublic: + type: boolean + Name: + description: 镜像名称 + type: string + Notes: + type: string + OsArch: + description: 'swagger: ignore' + type: string + OsType: + description: 'swagger: ignore' + type: string + Restart: + description: 'swagger: ignore' + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetBootIndexInput: + properties: + cdroms: + additionalProperties: + format: int8 + type: integer + description: key ordinal, value boot_index + type: object + x-go-name: Cdroms + disks: + additionalProperties: + format: int8 + type: integer + description: key index, value boot_index + type: object + x-go-name: Disks + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetExtraOptionInput: + properties: + key: + type: string + x-go-name: Key + value: + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetLiveMigrateParamsInput: + properties: + DowntimeLimitMS: + format: int64 + type: integer + MaxBandwidthMB: + format: int64 + type: integer + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSetPasswordInput: + properties: + AutoStart: + type: boolean + Password: + type: string + ResetPassword: + description: deploy params + type: boolean + Username: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSkuCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cloudregion_id: + default: default + description: 区域名称或Id,建议使用Id + type: string + x-go-name: CloudregionId + cpu_core_count: + description: Cpu核数 + format: int64 + maximum: 256 + minimum: 1 + type: integer + x-go-name: CpuCoreCount + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + instance_type_category: + default: general_purpose + description: |- + 套餐类型 + + + + instance_type_category | 说明 | + ----- | --- | + general_purpose |通用型 | + burstable |突发性能型 | + compute_optimized |计算优化型 | + memory_optimized |内存优化型 | + storage_optimized |存储IO优化型 | + hardware_accelerated |硬件加速型 | + high_storage |高存储型 | + high_memory |高内存型 | + type: string + x-go-name: InstanceTypeCategory + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + memory_size_mb: + description: 内存大小 + format: int64 + maximum: 524288 + minimum: 512 + type: integer + x-go-name: MemorySizeMB + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + postpaid_status: + default: available + description: 后付费状态 + type: string + x-go-name: PostpaidStatus + prepaid_status: + default: available + description: 预付费状态 + type: string + x-go-name: PrepaidStatus + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + zone_id: + description: 可用区名称或Id, 建议使用Id + type: string + x-go-name: ZoneId + required: + - name + - cpu_core_count + - memory_size_mb + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSkuDetails: + properties: + attached_disk_count: + format: int64 + type: integer + x-go-name: AttachedDiskCount + attached_disk_size_gb: + format: int64 + type: integer + x-go-name: AttachedDiskSizeGB + attached_disk_type: + type: string + x-go-name: AttachedDiskType + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + cpu_arch: + type: string + x-go-name: CpuArch + cpu_core_count: + description: CPU 架构 x86|xarm + format: int64 + type: integer + x-go-name: CpuCoreCount + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + data_disk_max_count: + format: int64 + type: integer + x-go-name: DataDiskMaxCount + data_disk_types: + type: string + x-go-name: DataDiskTypes + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + gpu_attachable: + type: boolean + x-go-name: GpuAttachable + gpu_count: + format: int64 + type: integer + x-go-name: GpuCount + gpu_max_count: + format: int64 + type: integer + x-go-name: GpuMaxCount + gpu_spec: + type: string + x-go-name: GpuSpec + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + instance_type_category: + description: x2 + type: string + x-go-name: InstanceTypeCategory + instance_type_family: + description: SkuId string `width:"64" charset:"ascii" nullable:"false" + list:"user" create:"admin_required"` // x2.large + type: string + x-go-name: InstanceTypeFamily + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + local_category: + description: 通用型 + type: string + x-go-name: LocalCategory + memory_size_mb: + format: int64 + type: integer + x-go-name: MemorySizeMB + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + nic_max_count: + format: int64 + type: integer + x-go-name: NicMaxCount + nic_type: + type: string + x-go-name: NicType + os_name: + type: string + x-go-name: OsName + postpaid_status: + description: 预付费资源状态 available|soldout + type: string + x-go-name: PostpaidStatus + prepaid_status: + type: string + x-go-name: PrepaidStatus + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + sys_disk_max_size_gb: + description: not required。 windows比较新的版本都是50G左右。 + format: int64 + type: integer + x-go-name: SysDiskMaxSizeGB + sys_disk_min_size_gb: + format: int64 + type: integer + x-go-name: SysDiskMinSizeGB + sys_disk_resizable: + type: boolean + x-go-name: SysDiskResizable + sys_disk_type: + type: string + x-go-name: SysDiskType + total_guest_count: + description: 绑定云主机数量 + format: int64 + type: integer + x-go-name: TotalGuestCount + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSkuUpdateInput: + properties: + attached_disk_count: + format: int64 + type: integer + x-go-name: AttachedDiskCount + attached_disk_size_gb: + format: int64 + type: integer + x-go-name: AttachedDiskSizeGB + attached_disk_type: + type: string + x-go-name: AttachedDiskType + data_disk_max_count: + format: int64 + type: integer + x-go-name: DataDiskMaxCount + data_disk_types: + type: string + x-go-name: DataDiskTypes + description: + description: 资源描述 + type: string + x-go-name: Description + gpu_attachable: + type: boolean + x-go-name: GpuAttachable + gpu_count: + format: int64 + type: integer + x-go-name: GpuCount + gpu_max_count: + format: int64 + type: integer + x-go-name: GpuMaxCount + gpu_spec: + type: string + x-go-name: GpuSpec + instance_type_category: + type: string + x-go-name: InstanceTypeCategory + instance_type_family: + type: string + x-go-name: InstanceTypeFamily + local_category: + type: string + x-go-name: LocalCategory + name: + description: 资源名称 + type: string + x-go-name: Name + nic_max_count: + format: int64 + type: integer + x-go-name: NicMaxCount + nic_type: + type: string + x-go-name: NicType + os_name: + type: string + x-go-name: OsName + postpaid_status: + default: available + description: 后付费状态 + type: string + x-go-name: PostpaidStatus + prepaid_status: + default: available + description: 预付费状态 + type: string + x-go-name: PrepaidStatus + progress: + format: float + type: number + x-go-name: Progress + sys_disk_max_size_gb: + format: int64 + type: integer + x-go-name: SysDiskMaxSizeGB + sys_disk_min_size_gb: + format: int64 + type: integer + x-go-name: SysDiskMinSizeGB + sys_disk_resizable: + type: boolean + x-go-name: SysDiskResizable + sys_disk_type: + type: string + x-go-name: SysDiskType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerSnapshotAndCloneInput: + properties: + auto_delete_instance_snapshot: + description: |- + Whether delete instance snapshot automatically + 是否自动删除主机快照 + type: boolean + x-go-name: AutoDeleteInstanceSnapshot + auto_start: + description: |- + Whether auto start the cloned server + 是否自动启动 + type: boolean + x-go-name: AutoStart + count: + description: |- + number of cloned servers + 数量 + format: int64 + type: integer + x-go-name: Count + generate_name: + type: string + x-go-name: GenerateName + instance_snapshot_id: + description: ignore + type: string + x-go-name: InstanceSnapshotId + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerStopInput: + properties: + is_force: + description: 是否强制关机 + type: boolean + x-go-name: IsForce + stop_charging: + description: |- + 是否关机停止计费, 若平台不支持停止计费，此参数无作用 + 目前仅阿里云，腾讯云此参数生效 + type: boolean + x-go-name: StopCharging + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerUpdateInput: + properties: + bios: + type: string + x-go-name: Bios + boot_order: + description: 启动顺序 + type: string + x-go-name: BootOrder + description: + description: 资源描述 + type: string + x-go-name: Description + disable_delete: + description: 删除保护开关 + type: boolean + x-go-name: DisableDelete + hostname: + description: |- + 主机名 + 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用 + 字符长度2-60个字符 + Windows: 字符长度2-15, 允许大小写英文字母, 数字和短横线, 不支持点号（.），不能全是数字 + 若输入为空，则会根据资源名称自动生成主机名 + 输入不为空则会自动剔除不符合规则的字符, 并进行校验 + 若长度大于允许的最大长度，会自动截取 + type: string + x-go-name: Hostname + machine: + type: string + x-go-name: Machine + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + progress_mbps: + description: 'swagger: ignore' + format: float + type: number + x-go-name: ProgressMbps + shutdown_behavior: + description: 关机执行操作 + type: string + x-go-name: ShutdownBehavior + src_ip_check: + type: boolean + x-go-name: SrcIpCheck + src_mac_check: + type: boolean + x-go-name: SrcMacCheck + ssh_port: + format: int64 + type: integer + x-go-name: SshPort + vdi: + type: string + x-go-name: Vdi + vga: + type: string + x-go-name: Vga + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerUserDataInput: + properties: + user_data: + type: string + x-go-name: UserData + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServerVncOutput: + description: +onecloud:model-api-gen + properties: + api_server: + description: cloudpods + type: string + x-go-name: ApiServer + connect_params: + type: string + x-go-name: ConnectParams + host: + description: kvm host ip + type: string + x-go-name: Host + host_id: + description: baremetal + type: string + x-go-name: HostId + hypervisor: + type: string + x-go-name: Hypervisor + id: + type: string + x-go-name: Id + instance_id: + type: string + x-go-name: InstanceId + instance_name: + type: string + x-go-name: InstanceName + os_name: + type: string + x-go-name: OsName + password: + type: string + x-go-name: Password + port: + format: int64 + type: integer + x-go-name: Port + protocol: + type: string + x-go-name: Protocol + session: + type: string + x-go-name: Session + url: + type: string + x-go-name: Url + vnc_password: + type: string + x-go-name: VncPassword + zone: + type: string + x-go-name: Zone + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + ServiceCatalogCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + guest_template: + description: 'description: the id or name of guest template' + example: good + type: string + x-go-name: GuestTemplate + icon_url: + description: 'description: service catalog icon url' + example: https://yunion.io/files/hello.png + type: string + x-go-name: IconUrl + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - guest_template + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServiceCatalogDeploy: + properties: + count: + description: 'description: the count of the new vm' + example: 1 + format: int64 + type: integer + x-go-name: Count + generate_name: + description: 'description: generate name automatically if name is repeated, + and only one of name and this shoudle be given' + example: hello + type: string + x-go-name: GenerateName + name: + description: 'description: name of the new vm' + example: hello + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServiceCatalogDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + guest_template_id: + type: string + x-go-name: GuestTemplateID + icon_url: + type: string + x-go-name: IconUrl + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ServiceCatalogUpdateInput: + properties: + guest_template: + description: 'description: the id or name of guest template' + example: good + type: string + x-go-name: GuestTemplate + icon_url: + description: 'description: service catalog icon url' + example: https://yunion.io/files/hello.png + type: string + x-go-name: IconUrl + name: + description: 'description: resource name' + example: test-network + type: string + uniqueItems: true + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SetDomainQuotaInput: + description: 设置域配额输入参数 + properties: + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + cloudaccount: + format: int64 + type: integer + x-go-name: Cloudaccount + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + dns_zone: + format: int64 + type: integer + x-go-name: DnsZone + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + globalvpc: + format: int64 + type: integer + x-go-name: Globalvpc + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SetInfrasQuotaInput: + description: 设置基础设施配额输入参数 + properties: + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + host: + format: int64 + type: integer + x-go-name: Host + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + format: int64 + type: integer + x-go-name: Vpc + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SetProjectQuotaInput: + description: 设置项目配额输入参数 + properties: + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + secgroup: + format: int64 + type: integer + x-go-name: Secgroup + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SetQuotaInput: + description: 设置主机配额输入参数 + properties: + Hypervisor: + description: 主机配额适用的主机类型，参考主机List的Hypervisor列表 + type: string + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + count: + description: 主机数量配额 + format: int64 + type: integer + x-go-name: Count + cpu: + description: 主机CPU核数量配额 + format: int64 + type: integer + x-go-name: Cpu + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + group: + description: 主机组配额 + format: int64 + type: integer + x-go-name: Group + isolated_device: + description: 直通设备(GPU)配额 + format: int64 + type: integer + x-go-name: IsolatedDevice + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + memory: + description: 主机内存容量配额 + format: int64 + type: integer + x-go-name: Memory + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + storage: + description: 主机存储容量配额 + format: int64 + type: integer + x-go-name: Storage + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone_id: + description: 配额适用的可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SetRegionQuotaInput: + description: 设置区域配额输入参数 + properties: + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + bucket: + format: int64 + type: integer + x-go-name: Bucket + cache: + format: int64 + type: integer + x-go-name: Cache + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + eip: + format: int64 + type: integer + x-go-name: Eip + eport: + format: int64 + type: integer + x-go-name: Eport + instance_snapshot: + format: int64 + type: integer + x-go-name: InstanceSnapshot + loadbalancer: + format: int64 + type: integer + x-go-name: Loadbalancer + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + mongodb: + format: int64 + type: integer + x-go-name: Mongodb + object_cnt: + format: int64 + type: integer + x-go-name: ObjectCnt + object_gb: + format: int64 + type: integer + x-go-name: ObjectGB + port: + format: int64 + type: integer + x-go-name: Port + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + rds: + format: int64 + type: integer + x-go-name: Rds + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + snapshot: + format: int64 + type: integer + x-go-name: Snapshot + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SetZoneQuotaInput: + description: 设置可用区配额输入参数 + properties: + account_id: + description: 配额适用的云账号ID + type: string + x-go-name: AccountId + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + brand: + description: 配额适用的品牌名称，参考List接口的品牌列表 + type: string + x-go-name: Brand + cloud_env: + description: 配额适用的云环境，参考List接口的云环境列表 + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + manager_id: + description: 配额适用的云订阅ID + type: string + x-go-name: ManagerId + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + provider: + description: 配额适用的平台名称，参考List接口的平台列表 + type: string + x-go-name: Provider + region_id: + description: 配额适用的区域ID + type: string + x-go-name: RegionId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + zone_id: + description: 配额适用的可用区ID + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/compute/models + SharableVirtualResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharableVirtualResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedDomain: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedProject: + properties: + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SimpleGuest: + properties: + cache_mode: + description: 缓存模式 + type: string + x-go-name: CacheMode + driver: + description: 磁盘驱动 + type: string + x-go-name: Driver + id: + description: 主机ID + type: string + x-go-name: Id + index: + description: 磁盘序号 + format: int64 + type: integer + x-go-name: Index + name: + description: 主机名称 + type: string + x-go-name: Name + status: + description: 主机状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SimpleHost: + properties: + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SimpleNetwork: + properties: + guest_ip_end: + type: string + x-go-name: GuestIpEnd + guest_ip_start: + type: string + x-go-name: GuestIpStart + guest_ip6_end: + type: string + x-go-name: GuestIp6End + guest_ip6_start: + type: string + x-go-name: GuestIp6Start + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SimpleSnapshot: + properties: + cloudregion_id: + description: 区域Id + type: string + x-go-name: CloudregionId + created_at: + description: 创建时间 + format: date-time + type: string + x-go-name: CreatedAt + disk_type: + description: 磁盘类型 + type: string + x-go-name: DiskType + encrypt_key_id: + description: 密钥 + type: string + x-go-name: EncryptKeyId + id: + description: 快照Id + type: string + x-go-name: Id + name: + description: 快照名称 + type: string + x-go-name: Name + size: + description: 快照大小 + format: int64 + type: integer + x-go-name: Size + status: + description: 快照状态 + type: string + x-go-name: Status + storage_id: + description: 存储Id + type: string + x-go-name: StorageId + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SimpleSnapshotPolicy: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + repeat_weekdays: + items: + format: int64 + type: integer + type: array + x-go-name: RepeatWeekdays + time_points: + items: + format: int64 + type: integer + type: array + x-go-name: TimePoints + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SkuSyncInput: + properties: + cloudregion_ids: + description: 区域ID + items: + type: string + type: array + x-go-name: CloudregionIds + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_id: + description: |- + 磁盘Id + 目前仅VMware平台不支持创建快照,其余平台磁盘均支持创建快照 + type: string + x-go-name: DiskId + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + - disk_id + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + backing_disk_id: + type: string + x-go-name: BackingDiskId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + created_by: + type: string + x-go-name: CreatedBy + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disk_id: + description: 磁盘Id + type: string + x-go-name: DiskId + disk_name: + description: 磁盘名称 + type: string + x-go-name: DiskName + disk_status: + description: 磁盘状态 + type: string + x-go-name: DiskStatus + disk_type: + type: string + x-go-name: DiskType + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + environment: + description: Environment + type: string + x-go-name: Environment + expired_at: + format: date-time + type: string + x-go-name: ExpiredAt + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + fake_deleted: + type: boolean + x-go-name: FakeDeleted + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + guest: + description: 云主机名称 + type: string + x-go-name: Guest + guest_id: + description: 云主机Id + type: string + x-go-name: GuestId + guest_status: + description: 云主机状态 + type: string + x-go-name: GuestStatus + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_sub_snapshot: + description: 是否是子快照 + type: boolean + x-go-name: IsSubSnapshot + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + location: + type: string + x-go-name: Location + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + os_type: + description: 操作系统类型 + type: string + x-go-name: OsType + out_of_chain: + type: boolean + x-go-name: OutOfChain + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + ref_count: + description: create disk from snapshot, snapshot as disk backing file + format: int64 + type: integer + x-go-name: RefCount + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + size: + description: 快照大小,单位Mb + format: int64 + type: integer + x-go-name: Size + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_id: + description: Only onecloud has StorageId + type: string + x-go-name: StorageId + storage_type: + description: 存储类型 + type: string + x-go-name: StorageType + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotPolicyCacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + snapshotpolicy: + description: 快照策略名称 + type: string + x-go-name: Snapshotpolicy + snapshotpolicy_id: + description: 本地快照策略ID + type: string + x-go-name: SnapshotpolicyId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotPolicyDetails: + properties: + binding_disk_count: + format: int64 + type: integer + x-go-name: BindingDiskCount + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + is_activated: + type: boolean + x-go-name: IsActivated + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + repeat_weekdays: + description: 1~7, 1 is Monday + format: uint8 + type: integer + x-go-name: RepeatWeekdays + repeat_weekdays_display: + items: + format: int64 + type: integer + type: array + x-go-name: RepeatWeekdaysDisplay + retention_days: + format: int64 + type: integer + x-go-name: RetentionDays + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + time_points: + description: 0~23 + format: uint32 + type: integer + x-go-name: TimePoints + time_points_display: + items: + format: int64 + type: integer + type: array + x-go-name: TimePointsDisplay + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotPolicyDiskDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + disk: + $ref: '#/definitions/DiskDetails' + snapshotpolicy: + description: 快照策略名称 + type: string + x-go-name: Snapshotpolicy + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SnapshotSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StandaloneAnonResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneAnonResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneShortDesc: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusInfrasResourceBaseCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusInfrasResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StorageCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + medium_type: + default: ssd + description: 存储介质类型 + enum: + - rotate + - ' ssd' + - ' hybird' + type: string + x-go-name: MediumType + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + nfs_host: + description: 网络文件系统主机, storage_type 为 nfs 时,此参数必传 + example: 192.168.222.2 + type: string + x-go-name: NfsHost + nfs_shared_dir: + description: 网络文件系统共享目录, storage_type 为 nfs 时, 此参数必传 + example: /nfs_root/ + type: string + x-go-name: NfsSharedDir + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + rbd_client_mount_timeout: + default: 120 + description: ceph CephFS挂载超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdClientMountTimeout + rbd_key: + description: |- + ceph集群密码,若ceph集群开启cephx认证,此参数必传 + 可在ceph集群主机的/etc/ceph/ceph.client.admin.keyring文件中找到 + example: AQDigB9dtnDAKhAAxS6X4zi4BPR/lIle4nf4Dw== + type: string + x-go-name: RbdKey + rbd_mon_host: + description: |- + ceph认证主机, storage_type为 rbd 时,此参数为必传项 + 单个ip或以逗号分隔的多个ip具体可查询 /etc/ceph/ceph.conf 文件 + example: 192.168.222.3,192.168.222.4,192.168.222.99 + type: string + x-go-name: RbdMonHost + rbd_pool: + description: ceph使用的pool, storage_type为 rbd 时,此参数为必传项 + example: rbd + type: string + x-go-name: RbdPool + rbd_rados_mon_op_timeout: + default: 3 + description: ceph集群连接超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdRadosMonOpTimeout + rbd_rados_osd_op_timeout: + default: 1200 + description: ceph osd 操作超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdRadosOsdOpTimeout + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + storage_type: + description: |- + 存储类型 + + + + storage_type | 参数 |是否必传 | 默认值 | 说明 | + -------- | ------- | -------- | -------- | --------- | + rbd | rbd_mon_host | 是 | | ceph mon_host | + rbd | rbd_pool | 是 | | ceph pool | + rbd | rbd_key | 否 | |若cephx认证开启,此参数必传 | + rbd | rbd_rados_mon_op_timeout | 否 | 3 |单位: 秒 | + rbd | rbd_rados_osd_op_timeout | 否 | 1200 |单位: 秒 | + rbd | rbd_client_mount_timeout | 否 | 120 |单位: 秒 | + nfs | nfs_host | 是 | |网络文件系统主机 | + nfs | nfs_shared_dir | 是 | |网络文件系统共享目录 | + local: 本地存储 + rbd: ceph块存储, ceph存储创建时仅会检测是否重复创建，不会具体检测认证参数是否合法，只有挂载存储时 + 计算节点会验证参数，若挂载失败，宿主机和存储不会关联，可以通过查看存储日志查找挂载失败原因 + enum: + - local + - ' rbd' + - ' nfs' + - ' gpfs' + type: string + x-go-name: StorageType + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + - storage_type + - medium_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageDetails: + properties: + DiskCount: + format: int64 + type: integer + HostCount: + format: int64 + type: integer + SnapshotCount: + format: int64 + type: integer + Used: + format: int64 + type: integer + Wasted: + format: int64 + type: integer + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + actual_capacity_used: + description: |- + 实际容量大小，单位Mb + we always expect actual capacity great or equal than zero, otherwise something wrong + format: int64 + type: integer + x-go-name: ActualCapacityUsed + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + capacity: + description: 容量大小,单位Mb + format: int64 + type: integer + x-go-name: Capacity + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 可用区的区域ID + type: string + x-go-name: CloudregionId + cmtbound: + description: 超售比 + format: float + type: number + x-go-name: Cmtbound + commit_bound: + description: 超分比 + format: float + type: number + x-go-name: CommitBound + commit_rate: + description: 超分率 + format: double + type: number + x-go-name: CommitRate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + free_capacity: + description: 可使用容量 + format: int64 + type: integer + x-go-name: FreeCapacity + hosts: + items: + $ref: '#/definitions/StorageHost' + type: array + x-go-name: Hosts + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_sys_disk_store: + description: |- + indicating whether system disk can be allocated in this storage + 是否可以用作系统盘存储 + example: true + type: boolean + x-go-name: IsSysDiskStore + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + medium_type: + description: 介质类型 + example: ssd + type: string + x-go-name: MediumType + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + real_time_used_capacity: + format: int64 + type: integer + x-go-name: ActualUsed + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + reserved: + description: 预留容量大小 + format: int64 + type: integer + x-go-name: Reserved + schedtags: + items: + $ref: '#/definitions/SchedtagShortDescDetails' + type: array + x-go-name: Schedtags + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storage_conf: + description: 存储配置信息 + type: object + x-go-name: StorageConf + storage_type: + description: 存储类型 + example: local + type: string + x-go-name: StorageType + storagecache_id: + description: 存储缓存Id + type: string + x-go-name: StoragecacheId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_capacity: + description: 已使用容量大小 + format: int64 + type: integer + x-go-name: UsedCapacity + virtual_capacity: + description: 虚拟容量大小 + format: int64 + type: integer + x-go-name: VCapacity + waste_capacity: + description: 浪费容量大小(异常磁盘大小总和) + format: int64 + type: integer + x-go-name: WasteCapacity + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageForceDetachHostInput: + properties: + host_id: + description: Host id or name + type: string + x-go-name: HostId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StorageHost: + properties: + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageShortDesc: + properties: + capacity_mb: + format: int64 + type: integer + x-go-name: CapacityMb + enabled: + type: boolean + x-go-name: Enabled + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + status: + type: string + x-go-name: Status + storage_type: + type: string + x-go-name: StorageType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StorageUpdateInput: + properties: + UpdateStorageConf: + type: boolean + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + rbd_client_mount_timeout: + default: 120 + description: ceph CephFS挂载超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdClientMountTimeout + rbd_key: + description: |- + ceph集群密码,若ceph集群开启cephx认证,此参数必传 + 可在ceph集群主机的/etc/ceph/ceph.client.admin.keyring文件中找到 + example: AQDigB9dtnDAKhAAxS6X4zi4BPR/lIle4nf4Dw== + type: string + x-go-name: RbdKey + rbd_rados_mon_op_timeout: + default: 3 + description: ceph集群连接超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdRadosMonOpTimeout + rbd_rados_osd_op_timeout: + default: 1200 + description: ceph osd 操作超时时间, 单位秒 + format: int64 + type: integer + x-go-name: RbdRadosOsdOpTimeout + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StoragecacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + count: + description: 缓存镜像个数 + format: int64 + type: integer + x-go-name: Count + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + host: + description: 通过一致性哈希获取的一个管理宿主机信息 + type: object + x-go-name: Host + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + path: + description: 镜像存储地址 + type: string + x-go-name: Path + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + size: + description: 缓存镜像总大小 + format: int64 + type: integer + x-go-name: Size + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + storages: + description: 存储列表 + items: + type: string + type: array + x-go-name: Storages + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + StoragecachedimageDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + cachedimage: + description: 缓存镜像名称 + type: string + x-go-name: Cachedimage + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + host: + description: 通过一致性哈希获取的一个宿主机详情 + type: object + x-go-name: Host + image: + description: 镜像名称 + type: string + x-go-name: Image + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + reference: + description: 引用次数 + format: int64 + type: integer + x-go-name: Reference + size: + description: 镜像大小 + format: int64 + type: integer + x-go-name: Size + storagecache: + description: 存储缓存名称 + type: string + x-go-name: Storagecache + storages: + description: 存储列表 + items: + type: string + type: array + x-go-name: Storages + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SubAccounts: + description: +onecloud:model-api-gen + properties: + Accounts: + description: 若输出则是全量子账号列表，若输入，代表允许同步的子账号 + items: + $ref: '#/definitions/SSubAccount' + type: array + Cloudregions: + description: 若输出是云账号查询到的区域列表，若输入，代表允许同步的区域 + items: + properties: + Id: + description: 输入必填 + type: string + Name: + type: string + Status: + type: string + type: object + type: array + type: object + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + SubscriptonCreateInput: + properties: + enrollment_account_id: + description: EA 账号id, 可通过 cloud-account-enrollment-accounts接口获取里面的id字段 + type: string + x-go-name: EnrollmentAccountId + name: + description: 订阅名称 + type: string + x-go-name: Name + offer_type: + description: '可选值: MS-AZR-0017P(生产用途), MS-AZR-0148P(开发测试)' + type: string + x-go-name: OfferType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SyncImagesInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SyncRangeInput: + properties: + deep_sync: + type: boolean + x-go-name: DeepSync + force: + type: boolean + x-go-name: Force + full_sync: + type: boolean + x-go-name: FullSync + host: + items: + type: string + type: array + x-go-name: Host + region: + items: + type: string + type: array + x-go-name: Region + resources: + description: |- + 按资源类型同步，可输入多个 + enmu: project, compute, network, eip, loadbalancer, objectstore, rds, cache, event, cloudid, dnszone, public_ip, intervpcnetwork, saml_auth, quota, nat, nas, waf, mongodb, es, kafka, app, cdn, container, ipv6_gateway, tablestore, modelarts, vpcpeer, misc + items: + type: string + type: array + x-go-name: Resources + xor: + description: 极速模式(差量更新) + type: boolean + x-go-name: Xor + zone: + items: + type: string + type: array + x-go-name: Zone + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + SyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TBucketACLType: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TMongoDBBackupMethod: + description: 备份方法 + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TMongoDBBackupStatus: + description: 备份状态 + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TMongoDBBackupType: + description: 备份方式 + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TTagSet: + items: + $ref: '#/definitions/STag' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TWafAction: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafMatchField: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafMatchFieldValues: + items: + type: string + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafOperator: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafStatementType: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafTextTransformation: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TWafType: + type: string + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TablestoreCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TablestoreDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TablestoreUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TextTransformations: + items: + $ref: '#/definitions/TWafTextTransformation' + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + TimerCreateInput: + properties: + ExecTime: + description: 'description: 执行时间' + format: date-time + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + TimerDetails: + properties: + exec_time: + description: 'description: 执行时间' + format: date-time + type: string + x-go-name: ExecTime + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VSwitch: + properties: + distributed: + type: boolean + x-go-name: Distributed + guest_networks: + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: GuestNetworks + host_networks: + items: + $ref: '#/definitions/CANetConf' + type: array + x-go-name: HostNetworks + hosts: + items: + $ref: '#/definitions/SimpleHost' + type: array + x-go-name: Hosts + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VirtualJointResourceBaseDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualJointResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VpcCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + cidr_block: + description: CIDR_BLOCK + type: string + x-go-name: CidrBlock + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + globalvpc_id: + description: |- + 仅对谷歌云有用，若谷歌云订阅只有一个全局VPC，此参数可不传 + 若有多个全局VPC，谷歌云需要指定其中一个全局VPC + type: string + x-go-name: GlobalvpcId + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + accpet_vpc_peer_count: + format: int64 + type: integer + x-go-name: AcceptVpcPeerCount + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cidr_block: + description: CIDR地址段 + example: 192.168.222.0/24 + type: string + x-go-name: CidrBlock + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + direct: + description: Can it be connected directly + type: boolean + x-go-name: Direct + dns_zone_count: + description: DnsZone个数 + example: 2 + format: int64 + type: integer + x-go-name: DnsZoneCount + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + globalvpc: + description: 全局VPC名称 + type: string + x-go-name: Globalvpc + globalvpc_id: + type: string + x-go-name: GlobalvpcId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_default: + description: 是否是默认VPC + example: true + type: boolean + x-go-name: IsDefault + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + natgateway_count: + description: NAT网关个数 + example: 0 + format: int64 + type: integer + x-go-name: NatgatewayCount + network_count: + description: IP子网个数 + example: 2 + format: int64 + type: integer + x-go-name: NetworkCount + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + request_vpc_peer_count: + format: int64 + type: integer + x-go-name: RequestVpcPeerCount + routetable_count: + description: 路由表个数 + example: 0 + format: int64 + type: integer + x-go-name: RoutetableCount + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + wire_count: + description: 二层网络数量 + example: 1 + format: int64 + type: integer + x-go-name: WireCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcPeeringConnectionCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Bandwidth: + description: |- + 跨区域vpc对等连接带宽，仅对腾讯云有效 + 单位Mbps,可选值 10,20,50,100,200,500,1000 + format: int64 + type: integer + PeerVpcId: + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + type: string + x-go-name: VpcId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcPeeringConnectionDetails: + properties: + PeerVpcName: + type: string + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcPeeringConnectionUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcTopologyOutput: + properties: + name: + type: string + x-go-name: Name + status: + type: string + x-go-name: Status + wires: + items: + $ref: '#/definitions/WireTopologyOutput' + type: array + x-go-name: Wires + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + VpcUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafAddresses: + description: +onecloud:model-api-gen + items: + type: string + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + WafIPSetCacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_ip_set_id: + type: string + x-go-name: WafIPSetId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafIPSetDetails: + properties: + addresses: + $ref: '#/definitions/WafAddresses' + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafInstanceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + CloudResources: + description: |- + 关联云资源列表 + 阿里云要求输入此参数或source_ips + items: + $ref: '#/definitions/SCloudResource' + type: array + DefaultAction: + $ref: '#/definitions/DefaultAction' + Type: + $ref: '#/definitions/TWafType' + cloudprovider_id: + description: 列出关联指定云订阅(ID或Name)的资源 + type: string + x-go-name: CloudproviderId + cloudregion_id: + description: 区域名称或ID + type: string + x-go-name: CloudregionId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + source_ips: + $ref: '#/definitions/WafSourceIps' + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafInstanceDetails: + properties: + Rules: + items: + $ref: '#/definitions/SWafRule' + type: array + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + default_action: + $ref: '#/definitions/DefaultAction' + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRegexPatterns: + description: +onecloud:model-api-gen + items: + type: string + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + WafRegexSetCacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_regex_set_id: + type: string + x-go-name: WafRegexSetId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRegexSetDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + regex_patterns: + $ref: '#/definitions/WafRegexPatterns' + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Statements: + description: 条件表达式 + items: + $ref: '#/definitions/SWafStatement' + type: array + action: + $ref: '#/definitions/DefaultAction' + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + priority: + description: |- + 优先级,不可重复 + Azure优先级范围1-100 + format: int64 + type: integer + x-go-name: Priority + statement_condition: + description: 'enmu: and, or, not' + type: string + x-go-name: StatementCondition + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + waf_instance_id: + description: WAF实例Id + type: string + x-go-name: WafInstanceId + waf_rule_group_id: + description: |- + swagger: ignore + WAF规则组Id + type: string + x-go-name: WafRuleGroupId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleDetails: + properties: + Statements: + items: + $ref: '#/definitions/SWafStatement' + type: array + action: + $ref: '#/definitions/DefaultAction' + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + priority: + description: 规则优先级 + format: int64 + type: integer + x-go-name: Priority + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + statement_conditon: + description: 条件 + type: string + x-go-name: StatementConditon + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_instance_id: + description: 所属waf实例id + type: string + x-go-name: WafInstanceId + waf_rule_group_id: + description: 规则组的id + type: string + x-go-name: WafRuleGroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleGroupCacheDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: 云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_rule_group_id: + type: string + x-go-name: WafRuleGroupId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleGroupDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + type: string + x-go-name: CloudEnv + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + waf_type: + description: 支持的WAF类型,仅is_system=true时有效 + type: string + x-go-name: WafType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafRuleUpdateInput: + properties: + Statements: + description: 条件表达式 + items: + $ref: '#/definitions/SWafStatement' + type: array + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WafSourceIps: + items: + type: string + type: array + x-go-package: yunion.io/x/cloudmux/pkg/cloudprovider + WafSyncstatusInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + bandwidth: + default: 0 + description: '带宽大小,单位: Mbps' + format: int64 + type: integer + x-go-name: Bandwidth + bw: + description: Deprecated + format: int64 + type: integer + x-go-name: Bw + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + external_access_mode: + description: Vpc外网访问模式 + type: string + x-go-name: ExternalAccessMode + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + mtu: + default: 0 + description: mtu + format: int64 + maximum: 1000000 + minimum: 0 + type: integer + x-go-name: Mtu + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + vpc_id: + description: 关联VPC(ID或Name) + type: string + x-go-name: VpcId + zone_id: + description: 可用区ID或名称 + example: zone1 + type: string + x-go-name: ZoneId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireDetails: + properties: + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + account_id: + description: 云账号Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: AccountId + bandwidth: + description: 带宽大小, 单位Mbps + example: 1000 + format: int64 + type: integer + x-go-name: Bandwidth + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: VPC归属区域ID + type: string + x-go-name: CloudregionId + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + host_count: + description: Host数量 + example: 1 + format: int64 + type: integer + x-go-name: HostCount + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + manager: + description: 云订阅名称 + example: google-account + type: string + x-go-name: Manager + manager_domain: + description: 子订阅所在域名称 + example: Default + type: string + x-go-name: ManagerDomain + manager_domain_id: + description: 子订阅所在域Id + example: default + type: string + x-go-name: ManagerDomainId + manager_id: + description: VPC归属云订阅ID + type: string + x-go-name: ManagerId + manager_project: + description: 子订阅所在项目名称 + example: system + type: string + x-go-name: ManagerProject + manager_project_id: + description: 子订阅所在项目Id + example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c + type: string + x-go-name: ManagerProjectId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mtu: + description: MTU + example: 1500 + format: int64 + type: integer + x-go-name: Mtu + name: + description: 资源名称 + type: string + x-go-name: Name + networks: + description: IP子网数量 + example: 1 + format: int64 + type: integer + x-go-name: Networks + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + vpc: + description: Vpc Name + type: string + x-go-name: Vpc + vpc_ext_id: + description: VPC外部Id + type: string + x-go-name: VpcExtId + vpc_id: + type: string + x-go-name: VpcId + zone: + description: 可用区名称 + example: 北京一区 + type: string + x-go-name: Zone + zone_ext_id: + description: 纳管云的zoneId + type: string + x-go-name: ZoneExtId + zone_id: + type: string + x-go-name: ZoneId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireMergeFromInput: + properties: + merge_network: + description: 'description: if merge networks under wire' + type: boolean + x-go-name: MergeNetwork + sources: + description: 'description: wire ids or names to be merged from' + items: + type: string + type: array + x-go-name: Sources + required: + - sources + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireMergeInput: + properties: + merge_network: + description: 'description: if merge networks under wire' + type: boolean + x-go-name: MergeNetwork + target: + description: 'description: wire id or name to be merged' + example: test-wire + type: string + x-go-name: Target + required: + - target + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireMergeNetworkInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireTopologyOutput: + properties: + bandwidth: + format: int64 + type: integer + x-go-name: Bandwidth + hosts: + items: + $ref: '#/definitions/HostTopologyOutput' + type: array + x-go-name: Hosts + name: + type: string + x-go-name: Name + networks: + items: + $ref: '#/definitions/NetworkTopologyOutput' + type: array + x-go-name: Networks + status: + type: string + x-go-name: Status + zone: + type: string + x-go-name: Zone + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + WireUpdateInput: + properties: + bandwidth: + description: bandwidth in MB + format: int64 + type: integer + x-go-name: Bandwidth + description: + description: 资源描述 + type: string + x-go-name: Description + mtu: + description: MTU + example: 1500 + format: int64 + type: integer + x-go-name: Mtu + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ZoneCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + Cloudregion: + description: 区域名称或Id,建议使用Id + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute + ZoneDetails: + properties: + baremetals: + description: 可用区底下的裸金属服务器数量 + example: 1 + format: int64 + type: integer + x-go-name: Baremetals + baremetals_enabled: + description: 可用区底下启用的裸金属服务器数量 + example: 1 + format: int64 + type: integer + x-go-name: BaremetalsEnabled + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + cloudregion_id: + description: 归属区域ID + type: string + x-go-name: CloudregionId + contacts: + type: string + x-go-name: Contacts + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + environment: + description: Environment + type: string + x-go-name: Environment + external_id: + description: 云上Id, 对应云上资源自身Id + type: string + x-go-name: ExternalId + hosts: + description: 可用区底下的宿主机数量 + example: 3 + format: int64 + type: integer + x-go-name: Hosts + hosts_enabled: + description: 可用区底下启用的宿主机数量 + example: 2 + format: int64 + type: integer + x-go-name: HostsEnabled + id: + description: 资源UUID + type: string + x-go-name: Id + imported_at: + description: 资源导入时间 + format: date-time + type: string + x-go-name: ImportedAt + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + location: + type: string + x-go-name: Location + manager_uri: + type: string + x-go-name: ManagerUri + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + name_cn: + type: string + x-go-name: NameCn + networks: + description: 可用区底下的子网数量 + example: 1 + format: int64 + type: integer + x-go-name: Networks + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + source: + description: '资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目' + type: string + x-go-name: Source + status: + description: 资源状态 + type: string + x-go-name: Status + storages: + description: 可用区底下的块存储数量 + example: 1 + format: int64 + type: integer + x-go-name: Storages + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + wires: + description: 可用区底下的二层网络数量 + example: 3 + format: int64 + type: integer + x-go-name: Wires + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/compute +host: '"127.0.0.1:8889"' +info: + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Compute API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" +paths: + /access_group_caches: + get: + description: 列表 + operationId: access_group_cache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 权限组Id + in: query + name: access_group_id + type: string + x-go-name: AccessGroupId + - description: 以权限组排序 + in: query + name: order_by_access_group + type: string + x-go-name: OrderByAccessGroup + responses: + "200": + $ref: '#/responses/access_group_cache_ListItemFilterOutput' + summary: 列表 + tags: + - access_group_cache + post: + description: 新建 + operationId: access_group_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + access_group_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - access_group_cache + /access_group_caches/{id}: + delete: + description: 删除 + operationId: access_group_cache_CustomizeDelete + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - access_group_cache + get: + description: 获取详情 + operationId: access_group_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - access_group_cache + put: + description: 更新 + operationId: access_group_cache_ValidateUpdateData + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - access_group_cache + /access_group_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: access_group_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - access_group_cache + post: + description: 执行操作ClassMetadata + operationId: access_group_cache_PerformClassMetadata + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - access_group_cache + /access_group_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: access_group_cache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - access_group_cache + /access_group_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: access_group_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - access_group_cache + /access_group_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: access_group_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - access_group_cache + /access_group_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: access_group_cache_GetDetailsStatus + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - access_group_cache + post: + description: 执行操作Status + operationId: access_group_cache_PerformStatus + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - access_group_cache + /access_group_caches/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: access_group_cache_PerformSyncstatus + parameters: + - description: The Id or Name of access_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_cache: + $ref: '#/definitions/MountTargetSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_cache_PerformSyncstatusOutput' + summary: 同步权限组缓存状态 + tags: + - access_group_cache + /access_group_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: access_group_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/access_group_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - access_group_cache + /access_group_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: access_group_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + access_group_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - access_group_cache + /access_group_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: access_group_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/access_group_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - access_group_cache + /access_group_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: access_group_cache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/access_group_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - access_group_cache + /access_group_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: access_group_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/access_group_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - access_group_cache + /access_group_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: access_group_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/access_group_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - access_group_cache + /access_group_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: access_group_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/access_group_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - access_group_cache + /access_group_rules: + get: + description: 列表 + operationId: access_group_rule_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 权限组Id + in: query + name: access_group_id + type: string + x-go-name: AccessGroupId + - description: 以权限组排序 + in: query + name: order_by_access_group + type: string + x-go-name: OrderByAccessGroup + responses: + "200": + $ref: '#/responses/access_group_rule_ListItemFilterOutput' + summary: 权限组规则列表 + tags: + - access_group_rule + post: + description: 新建 + operationId: access_group_rule_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_ValidateCreateDataOutput' + summary: 创建权限组规则 + tags: + - access_group_rule + /access_group_rules/{id}: + delete: + description: 删除 + operationId: access_group_rule_CustomizeDelete + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_rule_CustomizeDeleteOutput' + summary: 删除 + tags: + - access_group_rule + get: + description: 获取详情 + operationId: access_group_rule_FetchCustomizeColumns + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_rule_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - access_group_rule + put: + description: 更新 + operationId: access_group_rule_ValidateUpdateData + parameters: + - description: The Id or Name of access_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_ValidateUpdateDataOutput' + summary: 更新 + tags: + - access_group_rule + /access_group_rules/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: access_group_rule_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/access_group_rule_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - access_group_rule + /access_group_rules/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: access_group_rule_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + access_group_rule: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_rule_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - access_group_rule + /access_group_rules/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: access_group_rule_GetPropertySplitable + responses: + "200": + $ref: '#/responses/access_group_rule_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - access_group_rule + /access_group_rules/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: access_group_rule_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/access_group_rule_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - access_group_rule + /access_groups: + get: + description: 列表 + operationId: access_group_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/access_group_ListItemFilterOutput' + summary: 列表 + tags: + - access_group + post: + description: 新建 + operationId: access_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - access_group + /access_groups/{id}: + delete: + description: 删除 + operationId: access_group_CustomizeDelete + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - access_group + get: + description: 获取详情 + operationId: access_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - access_group + put: + description: 更新 + operationId: access_group_ValidateUpdateData + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - access_group + /access_groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: access_group_PerformChangeOwner + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - access_group + /access_groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: access_group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - access_group + /access_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: access_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - access_group + post: + description: 执行操作ClassMetadata + operationId: access_group_PerformClassMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - access_group + /access_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: access_group_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - access_group + /access_groups/{id}/private: + post: + description: 执行操作Private + operationId: access_group_PerformPrivate + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformPrivateOutput' + summary: 执行操作Private + tags: + - access_group + /access_groups/{id}/public: + post: + description: 执行操作Public + operationId: access_group_PerformPublic + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformPublicOutput' + summary: 执行操作Public + tags: + - access_group + /access_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: access_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - access_group + /access_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: access_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - access_group + /access_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: access_group_GetDetailsStatus + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/access_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - access_group + post: + description: 执行操作Status + operationId: access_group_PerformStatus + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - access_group + /access_groups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: access_group_PerformSyncstatus + parameters: + - description: The Id or Name of access_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/MountTargetSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformSyncstatusOutput' + summary: 同步权限组状态 + tags: + - access_group + /access_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: access_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/access_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - access_group + /access_groups/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: access_group_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/access_group_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - access_group + /access_groups/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: access_group_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/access_group_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - access_group + /access_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: access_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + access_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/access_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - access_group + /access_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: access_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/access_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - access_group + /access_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: access_group_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/access_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - access_group + /access_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: access_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/access_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - access_group + /access_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: access_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/access_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - access_group + /access_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: access_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/access_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - access_group + /app_environments: + get: + description: 列表 + operationId: app_environment_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - in: query + name: AppId + type: string + - in: query + name: InstanceType + type: string + responses: + "200": + $ref: '#/responses/app_environment_ListItemFilterOutput' + summary: 列表 + tags: + - app_environment + post: + description: 新建 + operationId: app_environment_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/VirtualResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_ValidateCreateDataOutput' + summary: 新建 + tags: + - app_environment + /app_environments/{id}: + delete: + description: 删除 + operationId: app_environment_CustomizeDelete + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_CustomizeDeleteOutput' + summary: 删除 + tags: + - app_environment + get: + description: 获取详情 + operationId: app_environment_FetchCustomizeColumns + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - app_environment + put: + description: 更新 + operationId: app_environment_ValidateUpdateData + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_ValidateUpdateDataOutput' + summary: 更新 + tags: + - app_environment + /app_environments/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: app_environment_PerformCancelDelete + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - app_environment + /app_environments/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: app_environment_PerformChangeOwner + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - app_environment + /app_environments/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: app_environment_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - app_environment + /app_environments/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: app_environment_GetDetailsClassMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - app_environment + post: + description: 执行操作ClassMetadata + operationId: app_environment_PerformClassMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - app_environment + /app_environments/{id}/freeze: + post: + description: 执行操作Freeze + operationId: app_environment_PerformFreeze + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - app_environment + /app_environments/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: app_environment_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - app_environment + /app_environments/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: app_environment_PerformSetClassMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - app_environment + /app_environments/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: app_environment_PerformSetUserMetadata + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - app_environment + /app_environments/{id}/status: + get: + description: 获取指定信息Status + operationId: app_environment_GetDetailsStatus + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_environment_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - app_environment + post: + description: 执行操作Status + operationId: app_environment_PerformStatus + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformStatusOutput' + summary: 更新资源状态 + tags: + - app_environment + /app_environments/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: app_environment_PerformUnfreeze + parameters: + - description: The Id or Name of app_environment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - app_environment + /app_environments/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: app_environment_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - app_environment + /app_environments/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: app_environment_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - app_environment + /app_environments/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: app_environment_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - app_environment + /app_environments/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: app_environment_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - app_environment + /app_environments/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: app_environment_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - app_environment + /app_environments/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: app_environment_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + app_environment: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_environment_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - app_environment + /app_environments/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: app_environment_GetPropertySplitable + responses: + "200": + $ref: '#/responses/app_environment_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - app_environment + /app_environments/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: app_environment_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/app_environment_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - app_environment + /app_environments/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: app_environment_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - app_environment + /app_environments/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: app_environment_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - app_environment + /app_environments/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: app_environment_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/app_environment_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - app_environment + /apps: + get: + description: 列表 + operationId: app_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: tech_stack + type: string + x-go-name: TechStack + responses: + "200": + $ref: '#/responses/app_ListItemFilterOutput' + summary: 列表 + tags: + - app + post: + description: 新建 + operationId: app_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/VirtualResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_ValidateCreateDataOutput' + summary: 新建 + tags: + - app + /apps/{id}: + delete: + description: 删除 + operationId: app_CustomizeDelete + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_CustomizeDeleteOutput' + summary: 删除 + tags: + - app + get: + description: 获取详情 + operationId: app_FetchCustomizeColumns + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - app + put: + description: 更新 + operationId: app_ValidateUpdateData + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_ValidateUpdateDataOutput' + summary: 更新 + tags: + - app + /apps/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: app_PerformCancelDelete + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - app + /apps/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: app_PerformChangeOwner + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - app + /apps/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: app_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - app + /apps/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: app_GetDetailsClassMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - app + post: + description: 执行操作ClassMetadata + operationId: app_PerformClassMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - app + /apps/{id}/freeze: + post: + description: 执行操作Freeze + operationId: app_PerformFreeze + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - app + /apps/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: app_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - app + /apps/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: app_PerformRemoteUpdate + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - app + /apps/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: app_PerformSetClassMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - app + /apps/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: app_PerformSetUserMetadata + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - app + /apps/{id}/status: + get: + description: 获取指定信息Status + operationId: app_GetDetailsStatus + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - app + post: + description: 执行操作Status + operationId: app_PerformStatus + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformStatusOutput' + summary: 更新资源状态 + tags: + - app + /apps/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: app_PerformSyncstatus + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/app_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - app + /apps/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: app_PerformUnfreeze + parameters: + - description: The Id or Name of app + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - app + /apps/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: app_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/app_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - app + /apps/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: app_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/app_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - app + /apps/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: app_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/app_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - app + /apps/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: app_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/app_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - app + /apps/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: app_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/app_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - app + /apps/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: app_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + app: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/app_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - app + /apps/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: app_GetPropertySplitable + responses: + "200": + $ref: '#/responses/app_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - app + /apps/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: app_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/app_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - app + /apps/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: app_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/app_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - app + /apps/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: app_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/app_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - app + /apps/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: app_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/app_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - app + /backup_storages: + get: + description: 列表 + operationId: backup_storage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/backup_storage_ListItemFilterOutput' + summary: 列表 + tags: + - backup_storage + post: + description: 新建 + operationId: backup_storage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_ValidateCreateDataOutput' + summary: 新建 + tags: + - backup_storage + /backup_storages/{id}: + delete: + description: 删除 + operationId: backup_storage_CustomizeDelete + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_CustomizeDeleteOutput' + summary: 删除 + tags: + - backup_storage + get: + description: 获取详情 + operationId: backup_storage_FetchCustomizeColumns + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - backup_storage + put: + description: 更新 + operationId: backup_storage_ValidateUpdateData + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - backup_storage + /backup_storages/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: backup_storage_PerformChangeOwner + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - backup_storage + /backup_storages/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: backup_storage_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - backup_storage + /backup_storages/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: backup_storage_GetDetailsClassMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - backup_storage + post: + description: 执行操作ClassMetadata + operationId: backup_storage_PerformClassMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - backup_storage + /backup_storages/{id}/disable: + post: + description: 执行操作Disable + operationId: backup_storage_PerformDisable + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformDisableOutput' + summary: 禁用资源 + tags: + - backup_storage + /backup_storages/{id}/enable: + post: + description: 执行操作Enable + operationId: backup_storage_PerformEnable + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformEnableOutput' + summary: 启用资源 + tags: + - backup_storage + /backup_storages/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: backup_storage_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - backup_storage + /backup_storages/{id}/private: + post: + description: 执行操作Private + operationId: backup_storage_PerformPrivate + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformPrivateOutput' + summary: 执行操作Private + tags: + - backup_storage + /backup_storages/{id}/public: + post: + description: 执行操作Public + operationId: backup_storage_PerformPublic + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformPublicOutput' + summary: 执行操作Public + tags: + - backup_storage + /backup_storages/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: backup_storage_PerformSetClassMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - backup_storage + /backup_storages/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: backup_storage_PerformSetUserMetadata + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - backup_storage + /backup_storages/{id}/status: + get: + description: 获取指定信息Status + operationId: backup_storage_GetDetailsStatus + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/backup_storage_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - backup_storage + post: + description: 执行操作Status + operationId: backup_storage_PerformStatus + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformStatusOutput' + summary: 更新资源状态 + tags: + - backup_storage + /backup_storages/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: backup_storage_PerformSyncstatus + parameters: + - description: The Id or Name of backup_storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/DiskBackupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - backup_storage + /backup_storages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: backup_storage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - backup_storage + /backup_storages/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: backup_storage_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - backup_storage + /backup_storages/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: backup_storage_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - backup_storage + /backup_storages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: backup_storage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + backup_storage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/backup_storage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - backup_storage + /backup_storages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: backup_storage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - backup_storage + /backup_storages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: backup_storage_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - backup_storage + /backup_storages/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: backup_storage_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - backup_storage + /backup_storages/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: backup_storage_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - backup_storage + /backup_storages/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: backup_storage_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/backup_storage_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - backup_storage + /baremetalagents: + get: + description: 列表 + operationId: baremetalagent_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以状态过滤 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以IP地址过滤 + in: query + items: + type: string + name: access_ip + type: array + x-go-name: AccessIp + - description: 以AgentType过滤 + in: query + items: + type: string + name: agent_type + type: array + x-go-name: AgentType + responses: + "200": + $ref: '#/responses/baremetalagent_ListItemFilterOutput' + summary: 管理代理服务列表 + tags: + - baremetalagent + post: + description: 新建 + operationId: baremetalagent_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_ValidateCreateDataOutput' + summary: 新建 + tags: + - baremetalagent + /baremetalagents/{id}: + delete: + description: 删除 + operationId: baremetalagent_CustomizeDelete + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_CustomizeDeleteOutput' + summary: 删除 + tags: + - baremetalagent + get: + description: 获取详情 + operationId: baremetalagent_FetchCustomizeColumns + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - baremetalagent + put: + description: 更新 + operationId: baremetalagent_ValidateUpdateData + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_ValidateUpdateDataOutput' + summary: 更新 + tags: + - baremetalagent + /baremetalagents/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: baremetalagent_GetDetailsClassMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - baremetalagent + post: + description: 执行操作ClassMetadata + operationId: baremetalagent_PerformClassMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - baremetalagent + /baremetalagents/{id}/disable: + post: + description: 执行操作Disable + operationId: baremetalagent_PerformDisable + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformDisableOutput' + summary: 执行操作Disable + tags: + - baremetalagent + /baremetalagents/{id}/disable-image-cache: + post: + description: 执行操作DisableImageCache + operationId: baremetalagent_PerformDisableImageCache + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformDisableImageCacheOutput' + summary: 执行操作DisableImageCache + tags: + - baremetalagent + /baremetalagents/{id}/enable: + post: + description: 执行操作Enable + operationId: baremetalagent_PerformEnable + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformEnableOutput' + summary: 执行操作Enable + tags: + - baremetalagent + /baremetalagents/{id}/enable-image-cache: + post: + description: 执行操作EnableImageCache + operationId: baremetalagent_PerformEnableImageCache + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformEnableImageCacheOutput' + summary: 执行操作EnableImageCache + tags: + - baremetalagent + /baremetalagents/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: baremetalagent_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - baremetalagent + /baremetalagents/{id}/offline: + post: + description: 执行操作Offline + operationId: baremetalagent_PerformOffline + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformOfflineOutput' + summary: 执行操作Offline + tags: + - baremetalagent + /baremetalagents/{id}/online: + post: + description: 执行操作Online + operationId: baremetalagent_PerformOnline + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/baremetalagent_PerformOnlineOutput' + summary: 执行操作Online + tags: + - baremetalagent + /baremetalagents/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: baremetalagent_PerformSetClassMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - baremetalagent + /baremetalagents/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: baremetalagent_PerformSetUserMetadata + parameters: + - description: The Id or Name of baremetalagent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - baremetalagent + /baremetalagents/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: baremetalagent_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - baremetalagent + /baremetalagents/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: baremetalagent_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + baremetalagent: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/baremetalagent_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - baremetalagent + /baremetalagents/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: baremetalagent_GetPropertySplitable + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - baremetalagent + /baremetalagents/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: baremetalagent_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - baremetalagent + /baremetalagents/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: baremetalagent_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - baremetalagent + /baremetalagents/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: baremetalagent_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/baremetalagent_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - baremetalagent + /billing_resource_checks: + get: + description: 列表 + operationId: billing_resource_check_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/billing_resource_check_ListItemFilterOutput' + summary: 列表 + tags: + - billing_resource_check + post: + description: 新建 + operationId: billing_resource_check_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/billing_resource_check_ValidateCreateDataOutput' + summary: 新建 + tags: + - billing_resource_check + /billing_resource_checks/{id}: + delete: + description: 删除 + operationId: billing_resource_check_CustomizeDelete + parameters: + - description: The Id or Name of billing_resource_check + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/billing_resource_check_CustomizeDeleteOutput' + summary: 删除 + tags: + - billing_resource_check + get: + description: 获取详情 + operationId: billing_resource_check_FetchCustomizeColumns + parameters: + - description: The Id or Name of billing_resource_check + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/billing_resource_check_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - billing_resource_check + put: + description: 更新 + operationId: billing_resource_check_ValidateUpdateData + parameters: + - description: The Id or Name of billing_resource_check + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/billing_resource_check_ValidateUpdateDataOutput' + summary: 更新 + tags: + - billing_resource_check + /billing_resource_checks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: billing_resource_check_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/billing_resource_check_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - billing_resource_check + /billing_resource_checks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: billing_resource_check_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + billing_resource_check: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/billing_resource_check_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - billing_resource_check + /billing_resource_checks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: billing_resource_check_GetPropertySplitable + responses: + "200": + $ref: '#/responses/billing_resource_check_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - billing_resource_check + /billing_resource_checks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: billing_resource_check_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/billing_resource_check_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - billing_resource_check + /buckets: + get: + description: 列表 + operationId: bucket_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: STORAGE_CLASS + in: query + items: + type: string + name: storage_class + type: array + x-go-name: StorageClass + - description: 位置 + in: query + items: + type: string + name: location + type: array + x-go-name: Location + - description: ACL + in: query + items: + type: string + name: acl + type: array + x-go-name: Acl + responses: + "200": + $ref: '#/responses/bucket_ListItemFilterOutput' + summary: 对象存储的存储桶列表 + tags: + - bucket + post: + description: 新建 + operationId: bucket_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_ValidateCreateDataOutput' + summary: 新建 + tags: + - bucket + /buckets/{id}: + delete: + description: 删除 + operationId: bucket_CustomizeDelete + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_CustomizeDeleteOutput' + summary: 删除 + tags: + - bucket + get: + description: 获取详情 + operationId: bucket_FetchCustomizeColumns + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - bucket + put: + description: 更新 + operationId: bucket_ValidateUpdateData + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_ValidateUpdateDataOutput' + summary: 更新 + tags: + - bucket + /buckets/{id}/access-info: + get: + description: 获取指定信息AccessInfo + operationId: bucket_GetDetailsAccessInfo + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsAccessInfoOutput' + summary: 获取指定信息AccessInfo + tags: + - bucket + /buckets/{id}/acl: + get: + description: |2- + + 获取对象或bucket的ACL + operationId: bucket_GetDetailsAcl + parameters: + - description: 对象KEY + in: query + name: key + type: string + x-go-name: Key + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsAclOutput' + summary: 获取对象或bucket的ACL + tags: + - bucket + post: + description: |2- + + 设置对象和bucket的ACL + operationId: bucket_PerformAcl + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketAclInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformAclOutput' + summary: 设置对象和bucket的ACL + tags: + - bucket + /buckets/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: bucket_PerformCancelDelete + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - bucket + /buckets/{id}/cdn-domain: + get: + description: 获取指定信息CdnDomain + operationId: bucket_GetDetailsCdnDomain + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsCdnDomainOutput' + summary: 获取指定信息CdnDomain + tags: + - bucket + /buckets/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: bucket_PerformChangeOwner + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - bucket + /buckets/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: bucket_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - bucket + /buckets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: bucket_GetDetailsClassMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - bucket + post: + description: 执行操作ClassMetadata + operationId: bucket_PerformClassMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - bucket + /buckets/{id}/cors: + get: + description: 获取指定信息Cors + operationId: bucket_GetDetailsCors + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsCorsOutput' + summary: 获取指定信息Cors + tags: + - bucket + /buckets/{id}/delete: + post: + description: |2- + + 删除对象 + operationId: bucket_PerformDelete + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPerformDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformDeleteOutput' + summary: 删除对象 + tags: + - bucket + /buckets/{id}/delete-cors: + post: + description: 执行操作DeleteCors + operationId: bucket_PerformDeleteCors + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketCORSRuleDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformDeleteCorsOutput' + summary: 执行操作DeleteCors + tags: + - bucket + /buckets/{id}/delete-policy: + post: + description: 执行操作DeletePolicy + operationId: bucket_PerformDeletePolicy + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPolicyDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformDeletePolicyOutput' + summary: 执行操作DeletePolicy + tags: + - bucket + /buckets/{id}/delete-website: + post: + description: 执行操作DeleteWebsite + operationId: bucket_PerformDeleteWebsite + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformDeleteWebsiteOutput' + summary: 执行操作DeleteWebsite + tags: + - bucket + /buckets/{id}/freeze: + post: + description: 执行操作Freeze + operationId: bucket_PerformFreeze + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - bucket + /buckets/{id}/limit: + post: + description: 执行操作Limit + operationId: bucket_PerformLimit + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformLimitOutput' + summary: 执行操作Limit + tags: + - bucket + /buckets/{id}/makedir: + post: + description: |2- + + 新建对象目录 + operationId: bucket_PerformMakedir + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPerformMakedirInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformMakedirOutput' + summary: 新建对象目录 + tags: + - bucket + /buckets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: bucket_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - bucket + post: + description: 执行操作Metadata + operationId: bucket_PerformMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketMetadataInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformMetadataOutput' + summary: 执行操作Metadata + tags: + - bucket + /buckets/{id}/objects: + get: + description: |2- + + 获取bucket的对象列表 + operationId: bucket_GetDetailsObjects + parameters: + - description: Prefix + in: query + name: prefix + type: string + x-go-name: Prefix + - description: 是否模拟列举目录模式 + in: query + name: recursive + type: boolean + x-go-name: Recursive + - description: 分页标识 + in: query + name: paging_marker + type: string + x-go-name: PagingMarker + - description: 最大输出条目数 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsObjectsOutput' + summary: 获取bucket的对象列表 + tags: + - bucket + /buckets/{id}/policy: + get: + description: 获取指定信息Policy + operationId: bucket_GetDetailsPolicy + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsPolicyOutput' + summary: 获取指定信息Policy + tags: + - bucket + /buckets/{id}/private: + post: + description: 执行操作Private + operationId: bucket_PerformPrivate + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformPrivateOutput' + summary: 执行操作Private + tags: + - bucket + /buckets/{id}/public: + post: + description: 执行操作Public + operationId: bucket_PerformPublic + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformPublicOutput' + summary: 执行操作Public + tags: + - bucket + /buckets/{id}/referer: + get: + description: 获取指定信息Referer + operationId: bucket_GetDetailsReferer + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsRefererOutput' + summary: 获取指定信息Referer + tags: + - bucket + /buckets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: bucket_PerformSetClassMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - bucket + /buckets/{id}/set-cors: + post: + description: 执行操作SetCors + operationId: bucket_PerformSetCors + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketCORSRules' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetCorsOutput' + summary: 执行操作SetCors + tags: + - bucket + /buckets/{id}/set-policy: + post: + description: 执行操作SetPolicy + operationId: bucket_PerformSetPolicy + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPolicyStatementInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetPolicyOutput' + summary: 执行操作SetPolicy + tags: + - bucket + /buckets/{id}/set-referer: + post: + description: 执行操作SetReferer + operationId: bucket_PerformSetReferer + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketRefererConf' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetRefererOutput' + summary: 执行操作SetReferer + tags: + - bucket + /buckets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: bucket_PerformSetUserMetadata + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - bucket + /buckets/{id}/set-website: + post: + description: 执行操作SetWebsite + operationId: bucket_PerformSetWebsite + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketWebsiteConf' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSetWebsiteOutput' + summary: 执行操作SetWebsite + tags: + - bucket + /buckets/{id}/status: + get: + description: 获取指定信息Status + operationId: bucket_GetDetailsStatus + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - bucket + post: + description: 执行操作Status + operationId: bucket_PerformStatus + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformStatusOutput' + summary: 更新资源状态 + tags: + - bucket + /buckets/{id}/sync: + post: + description: 执行操作Sync + operationId: bucket_PerformSync + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformSyncOutput' + summary: 执行操作Sync + tags: + - bucket + /buckets/{id}/syncstatus: + post: + description: |2- + + 同步存储桶状态 + operationId: bucket_PerformSyncstatus + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformSyncstatusOutput' + summary: 同步存储桶状态 + tags: + - bucket + /buckets/{id}/temp-url: + post: + description: |2- + + 获取访问对象的临时URL + operationId: bucket_PerformTempUrl + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/BucketPerformTempUrlInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformTempUrlOutput' + summary: 获取访问对象的临时URL + tags: + - bucket + /buckets/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: bucket_PerformUnfreeze + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - bucket + /buckets/{id}/upload: + post: + description: |2- + + 上传对象 + operationId: bucket_PerformUpload + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_PerformUploadOutput' + summary: 上传对象 + tags: + - bucket + /buckets/{id}/website: + get: + description: 获取指定信息Website + operationId: bucket_GetDetailsWebsite + parameters: + - description: The Id or Name of bucket + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/bucket_GetDetailsWebsiteOutput' + summary: 获取指定信息Website + tags: + - bucket + /buckets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: bucket_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/bucket_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - bucket + /buckets/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: bucket_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/bucket_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - bucket + /buckets/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: bucket_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/bucket_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - bucket + /buckets/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: bucket_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/bucket_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - bucket + /buckets/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: bucket_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/bucket_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - bucket + /buckets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: bucket_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + bucket: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/bucket_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - bucket + /buckets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: bucket_GetPropertySplitable + responses: + "200": + $ref: '#/responses/bucket_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - bucket + /buckets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: bucket_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/bucket_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - bucket + /buckets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: bucket_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/bucket_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - bucket + /buckets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: bucket_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/bucket_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - bucket + /buckets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: bucket_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/bucket_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - bucket + /cachedimages: + get: + description: 列表 + operationId: cachedimage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: '镜像类型，可能值为: system(公有云公共镜像), customized(自定义镜像)' + example: system + in: query + items: + type: string + name: image_type + type: array + x-go-name: ImageType + - description: filter by host schedtag + in: query + name: host_schedtag_id + type: string + x-go-name: HostSchedtagId + - description: valid cachedimage + in: query + name: valid + type: boolean + x-go-name: Valid + responses: + "200": + $ref: '#/responses/cachedimage_ListItemFilterOutput' + summary: 缓存镜像列表 + tags: + - cachedimage + post: + description: 新建 + operationId: cachedimage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/SharableVirtualResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_ValidateCreateDataOutput' + summary: 新建 + tags: + - cachedimage + /cachedimages/{id}: + delete: + description: 删除 + operationId: cachedimage_CustomizeDelete + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_CustomizeDeleteOutput' + summary: 删除 + tags: + - cachedimage + get: + description: 获取详情 + operationId: cachedimage_FetchCustomizeColumns + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cachedimage + put: + description: 更新 + operationId: cachedimage_ValidateUpdateData + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cachedimage + /cachedimages/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: cachedimage_PerformCancelDelete + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - cachedimage + /cachedimages/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cachedimage_PerformChangeOwner + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cachedimage + /cachedimages/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cachedimage_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cachedimage + /cachedimages/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cachedimage_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cachedimage + post: + description: 执行操作ClassMetadata + operationId: cachedimage_PerformClassMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cachedimage + /cachedimages/{id}/freeze: + post: + description: 执行操作Freeze + operationId: cachedimage_PerformFreeze + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - cachedimage + /cachedimages/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cachedimage_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cachedimage + /cachedimages/{id}/private: + post: + description: 执行操作Private + operationId: cachedimage_PerformPrivate + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cachedimage + /cachedimages/{id}/public: + post: + description: 执行操作Public + operationId: cachedimage_PerformPublic + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformPublicOutput' + summary: 执行操作Public + tags: + - cachedimage + /cachedimages/{id}/refresh: + post: + description: 执行操作Refresh + operationId: cachedimage_PerformRefresh + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_PerformRefreshOutput' + summary: 执行操作Refresh + tags: + - cachedimage + /cachedimages/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cachedimage_PerformSetClassMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cachedimage + /cachedimages/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cachedimage_PerformSetUserMetadata + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cachedimage + /cachedimages/{id}/status: + get: + description: 获取指定信息Status + operationId: cachedimage_GetDetailsStatus + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cachedimage_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cachedimage + post: + description: 执行操作Status + operationId: cachedimage_PerformStatus + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cachedimage + /cachedimages/{id}/uncache-image: + post: + description: 执行操作UncacheImage + operationId: cachedimage_PerformUncacheImage + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedImageUncacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformUncacheImageOutput' + summary: 清除镜像缓存 + tags: + - cachedimage + /cachedimages/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: cachedimage_PerformUnfreeze + parameters: + - description: The Id or Name of cachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - cachedimage + /cachedimages/cache-image: + post: + description: 执行操作CacheImage + operationId: cachedimage_PerformCacheImage + parameters: + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedImageManagerCacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformCacheImageOutput' + summary: 执行操作CacheImage + tags: + - cachedimage + /cachedimages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cachedimage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cachedimage + /cachedimages/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: cachedimage_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - cachedimage + /cachedimages/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: cachedimage_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - cachedimage + /cachedimages/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: cachedimage_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - cachedimage + /cachedimages/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: cachedimage_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - cachedimage + /cachedimages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cachedimage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cachedimage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cachedimage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cachedimage + /cachedimages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cachedimage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cachedimage + /cachedimages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cachedimage_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cachedimage + /cachedimages/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cachedimage_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cachedimage + /cachedimages/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cachedimage_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cachedimage + /cachedimages/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cachedimage_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cachedimage_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cachedimage + /cdn_domains: + get: + description: 列表 + operationId: cdn_domain_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/cdn_domain_ListItemFilterOutput' + summary: 列出CDN域名 + tags: + - cdn_domain + post: + description: 新建 + operationId: cdn_domain_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_ValidateCreateDataOutput' + summary: 新建 + tags: + - cdn_domain + /cdn_domains/{id}: + delete: + description: 删除 + operationId: cdn_domain_CustomizeDelete + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_CustomizeDeleteOutput' + summary: 删除 + tags: + - cdn_domain + get: + description: 获取详情 + operationId: cdn_domain_FetchCustomizeColumns + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cdn_domain + put: + description: 更新 + operationId: cdn_domain_ValidateUpdateData + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cdn_domain + /cdn_domains/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: cdn_domain_PerformCancelDelete + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - cdn_domain + /cdn_domains/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: cdn_domain_PerformChangeOwner + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - cdn_domain + /cdn_domains/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cdn_domain_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cdn_domain + /cdn_domains/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cdn_domain_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cdn_domain + post: + description: 执行操作ClassMetadata + operationId: cdn_domain_PerformClassMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cdn_domain + /cdn_domains/{id}/disable: + post: + description: 执行操作Disable + operationId: cdn_domain_PerformDisable + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformDisableOutput' + summary: 禁用资源 + tags: + - cdn_domain + /cdn_domains/{id}/enable: + post: + description: 执行操作Enable + operationId: cdn_domain_PerformEnable + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformEnableOutput' + summary: 启用资源 + tags: + - cdn_domain + /cdn_domains/{id}/freeze: + post: + description: 执行操作Freeze + operationId: cdn_domain_PerformFreeze + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - cdn_domain + /cdn_domains/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cdn_domain_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cdn_domain + /cdn_domains/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: cdn_domain_PerformRemoteUpdate + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - cdn_domain + /cdn_domains/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cdn_domain_PerformSetClassMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cdn_domain + /cdn_domains/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cdn_domain_PerformSetUserMetadata + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cdn_domain + /cdn_domains/{id}/status: + get: + description: 获取指定信息Status + operationId: cdn_domain_GetDetailsStatus + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cdn_domain_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cdn_domain + post: + description: 执行操作Status + operationId: cdn_domain_PerformStatus + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cdn_domain + /cdn_domains/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: cdn_domain_PerformSyncstatus + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/NatGatewaySyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformSyncstatusOutput' + summary: 同步域名状态 + tags: + - cdn_domain + /cdn_domains/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: cdn_domain_PerformUnfreeze + parameters: + - description: The Id or Name of cdn_domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - cdn_domain + /cdn_domains/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cdn_domain_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cdn_domain + /cdn_domains/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: cdn_domain_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - cdn_domain + /cdn_domains/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: cdn_domain_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - cdn_domain + /cdn_domains/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: cdn_domain_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - cdn_domain + /cdn_domains/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: cdn_domain_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - cdn_domain + /cdn_domains/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cdn_domain_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cdn_domain: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cdn_domain_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cdn_domain + /cdn_domains/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cdn_domain_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cdn_domain + /cdn_domains/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cdn_domain_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cdn_domain + /cdn_domains/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cdn_domain_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cdn_domain + /cdn_domains/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cdn_domain_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cdn_domain + /cdn_domains/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cdn_domain_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cdn_domain_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cdn_domain + /cloudaccounts: + get: + description: 列表 + operationId: cloudaccount_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 根据该云平台的功能对云账号或云订阅进行过滤 + in: query + items: + type: string + name: capability + type: array + x-go-name: Capability + - description: 同步状态 + in: query + items: + type: string + name: sync_status + type: array + x-go-name: SyncStatus + - description: 账号健康状态 + in: query + items: + type: string + name: health_status + type: array + x-go-name: HealthStatus + - description: 共享模式 + in: query + items: + type: string + name: share_mode + type: array + x-go-name: ShareMode + - description: 代理 + in: query + name: proxy_setting + type: string + x-go-name: ProxySetting + - description: 按宿主机数量排序 + in: query + name: order_by_host_count + pattern: asc|desc + type: string + x-go-name: OrderByHostCount + - description: 按虚拟机数量排序 + in: query + name: order_by_guest_count + pattern: asc|desc + type: string + x-go-name: OrderByGuestCount + responses: + "200": + $ref: '#/responses/cloudaccount_ListItemFilterOutput' + summary: 云账号列表 + tags: + - cloudaccount + post: + description: 新建 + operationId: cloudaccount_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudaccount + /cloudaccounts/{id}: + delete: + description: 删除 + operationId: cloudaccount_CustomizeDelete + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudaccount + get: + description: 获取详情 + operationId: cloudaccount_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudaccount + put: + description: 更新 + operationId: cloudaccount_ValidateUpdateData + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudaccount + /cloudaccounts/{id}/balance: + get: + description: 获取指定信息Balance + operationId: cloudaccount_GetDetailsBalance + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsBalanceOutput' + summary: 获取指定信息Balance + tags: + - cloudaccount + /cloudaccounts/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudaccount_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudaccount + /cloudaccounts/{id}/change-project: + post: + description: 执行操作ChangeProject + operationId: cloudaccount_PerformChangeProject + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformChangeProjectOutput' + summary: 执行操作ChangeProject + tags: + - cloudaccount + /cloudaccounts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudaccount_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudaccount + post: + description: 执行操作ClassMetadata + operationId: cloudaccount_PerformClassMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudaccount + /cloudaccounts/{id}/create-subscription: + post: + description: 执行操作CreateSubscription + operationId: cloudaccount_PerformCreateSubscription + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/SubscriptonCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformCreateSubscriptionOutput' + summary: 创建Azure订阅 + tags: + - cloudaccount + /cloudaccounts/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudaccount_PerformDisable + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformDisableOutput' + summary: 执行操作Disable + tags: + - cloudaccount + /cloudaccounts/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudaccount_PerformEnable + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformEnableOutput' + summary: 执行操作Enable + tags: + - cloudaccount + /cloudaccounts/{id}/enrollment-accounts: + get: + description: 获取指定信息EnrollmentAccounts + operationId: cloudaccount_GetDetailsEnrollmentAccounts + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsEnrollmentAccountsOutput' + summary: 获取Azure Enrollment Accounts + tags: + - cloudaccount + /cloudaccounts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudaccount_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudaccount + /cloudaccounts/{id}/private: + post: + description: 执行操作Private + operationId: cloudaccount_PerformPrivate + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformPrivateOutput' + summary: 执行操作Private + tags: + - cloudaccount + /cloudaccounts/{id}/project-mapping: + post: + description: 执行操作ProjectMapping + operationId: cloudaccount_PerformProjectMapping + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountProjectMappingInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformProjectMappingOutput' + summary: 绑定同步策略 + tags: + - cloudaccount + /cloudaccounts/{id}/public: + post: + description: 执行操作Public + operationId: cloudaccount_PerformPublic + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountPerformPublicInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformPublicOutput' + summary: 执行操作Public + tags: + - cloudaccount + /cloudaccounts/{id}/saml: + get: + description: 获取指定信息Saml + operationId: cloudaccount_GetDetailsSaml + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsSamlOutput' + summary: 获取指定信息Saml + tags: + - cloudaccount + /cloudaccounts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudaccount_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudaccount + /cloudaccounts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudaccount_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudaccount + /cloudaccounts/{id}/share-mode: + post: + description: 执行操作ShareMode + operationId: cloudaccount_PerformShareMode + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountShareModeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformShareModeOutput' + summary: Deprecated + tags: + - cloudaccount + /cloudaccounts/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudaccount_GetDetailsStatus + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudaccount + post: + description: 执行操作Status + operationId: cloudaccount_PerformStatus + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudaccount + /cloudaccounts/{id}/sync: + post: + description: 执行操作Sync + operationId: cloudaccount_PerformSync + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/SyncRangeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSyncOutput' + summary: 执行操作Sync + tags: + - cloudaccount + /cloudaccounts/{id}/sync-skus: + post: + description: 执行操作SyncSkus + operationId: cloudaccount_PerformSyncSkus + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountSyncSkusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - cloudaccount + /cloudaccounts/{id}/test-connectivity: + post: + description: 执行操作TestConnectivity + operationId: cloudaccount_PerformTestConnectivity + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/SCloudaccountCredential' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformTestConnectivityOutput' + summary: 测试账号连通性(更新秘钥信息时) + tags: + - cloudaccount + /cloudaccounts/{id}/update-credential: + post: + description: 执行操作UpdateCredential + operationId: cloudaccount_PerformUpdateCredential + parameters: + - description: The Id or Name of cloudaccount + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudaccount_PerformUpdateCredentialOutput' + summary: 执行操作UpdateCredential + tags: + - cloudaccount + /cloudaccounts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudaccount_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudaccount + /cloudaccounts/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: cloudaccount_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - cloudaccount + /cloudaccounts/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: cloudaccount_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - cloudaccount + /cloudaccounts/prepare-nets: + post: + description: 执行操作PrepareNets + operationId: cloudaccount_PerformPrepareNets + parameters: + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountPerformPrepareNetsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformPrepareNetsOutput' + summary: Performpreparenets searches for suitable network facilities for physical + and virtual machines under the cloud account or provides configuration recommendations + for network facilities before importing a cloud account. + tags: + - cloudaccount + /cloudaccounts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudaccount_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudaccount: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudaccount_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudaccount + /cloudaccounts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudaccount_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudaccount + /cloudaccounts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudaccount_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudaccount + /cloudaccounts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudaccount_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudaccount + /cloudaccounts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudaccount_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudaccount + /cloudaccounts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudaccount_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudaccount_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudaccount + /cloudimages: + get: + description: 列表 + operationId: cloudimage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + responses: + "200": + $ref: '#/responses/cloudimage_ListItemFilterOutput' + summary: 列表 + tags: + - cloudimage + post: + description: 新建 + operationId: cloudimage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudimage + /cloudimages/{id}: + delete: + description: 删除 + operationId: cloudimage_CustomizeDelete + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudimage + get: + description: 获取详情 + operationId: cloudimage_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudimage + put: + description: 更新 + operationId: cloudimage_ValidateUpdateData + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudimage + /cloudimages/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudimage_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudimage + post: + description: 执行操作ClassMetadata + operationId: cloudimage_PerformClassMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudimage + /cloudimages/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudimage_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudimage_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudimage + /cloudimages/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudimage_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudimage + /cloudimages/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudimage_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudimage + /cloudimages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudimage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudimage + /cloudimages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudimage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudimage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudimage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudimage + /cloudimages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudimage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudimage + /cloudimages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudimage_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudimage + /cloudimages/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudimage_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudimage + /cloudimages/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudimage_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudimage_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudimage + /cloudproviderregions: + get: + description: 列表 + operationId: cloudproviderregion_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 同步状态 + in: query + items: + type: string + name: sync_status + type: array + x-go-name: SyncStatus + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 根据该云平台的功能对云账号或云订阅进行过滤 + in: query + items: + type: string + name: capability + type: array + x-go-name: Capability + - description: 是否启用 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/cloudproviderregion_ListItemFilterOutput' + summary: 列表 + tags: + - cloudproviderregion + post: + description: 新建 + operationId: cloudproviderregion_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/JoinResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudproviderregion_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudproviderregion + /cloudproviderregions/{id}: + delete: + description: 删除 + operationId: cloudproviderregion_CustomizeDelete + parameters: + - description: The Id or Name of cloudproviderregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudproviderregion_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudproviderregion + get: + description: 获取详情 + operationId: cloudproviderregion_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudproviderregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudproviderregion_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudproviderregion + put: + description: 更新 + operationId: cloudproviderregion_ValidateUpdateData + parameters: + - description: The Id or Name of cloudproviderregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudproviderregion_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudproviderregion + /cloudproviderregions/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudproviderregion_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudproviderregion_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudproviderregion + /cloudproviderregions/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudproviderregion_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudproviderregion_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudproviderregion + /cloudproviderregions/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudproviderregion_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudproviderregion_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudproviderregion + /cloudproviderregions/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudproviderregion_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudproviderregion_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudproviderregion + /cloudproviders: + get: + description: 列表 + operationId: cloudprovider_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 根据该云平台的功能对云账号或云订阅进行过滤 + in: query + items: + type: string + name: capability + type: array + x-go-name: Capability + - description: 同步状态 + in: query + items: + type: string + name: sync_status + type: array + x-go-name: SyncStatus + - description: 账号健康状态 + in: query + items: + type: string + name: health_status + type: array + x-go-name: HealthStatus + - description: filter by host schedtag + in: query + name: host_schedtag_id + type: string + x-go-name: HostSchedtagId + responses: + "200": + $ref: '#/responses/cloudprovider_ListItemFilterOutput' + summary: 云订阅列表 + tags: + - cloudprovider + /cloudproviders/{id}: + delete: + description: 删除 + operationId: cloudprovider_CustomizeDelete + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudprovider + get: + description: 获取详情 + operationId: cloudprovider_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudprovider + put: + description: 更新 + operationId: cloudprovider_ValidateUpdateData + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudprovider + /cloudproviders/{id}/canned-acls: + get: + description: 获取指定信息CannedAcls + operationId: cloudprovider_GetDetailsCannedAcls + parameters: + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsCannedAclsOutput' + summary: 获取指定信息CannedAcls + tags: + - cloudprovider + /cloudproviders/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: cloudprovider_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - cloudprovider + /cloudproviders/{id}/change-project: + post: + description: 执行操作ChangeProject + operationId: cloudprovider_PerformChangeProject + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformChangeProjectOutput' + summary: 执行操作ChangeProject + tags: + - cloudprovider + /cloudproviders/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudprovider_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudprovider + post: + description: 执行操作ClassMetadata + operationId: cloudprovider_PerformClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/clirc: + get: + description: 获取指定信息Clirc + operationId: cloudprovider_GetDetailsClirc + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsClircOutput' + summary: 获取指定信息Clirc + tags: + - cloudprovider + /cloudproviders/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudprovider_PerformDisable + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformDisableOutput' + summary: 执行操作Disable + tags: + - cloudprovider + /cloudproviders/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudprovider_PerformEnable + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformEnableOutput' + summary: 执行操作Enable + tags: + - cloudprovider + /cloudproviders/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudprovider_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudprovider + /cloudproviders/{id}/project-mapping: + post: + description: 执行操作ProjectMapping + operationId: cloudprovider_PerformProjectMapping + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudaccountProjectMappingInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformProjectMappingOutput' + summary: 绑定同步策略 + tags: + - cloudprovider + /cloudproviders/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudprovider_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudprovider + /cloudproviders/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: cloudprovider_PerformSetSchedtag + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - cloudprovider + /cloudproviders/{id}/set-syncing: + post: + description: 执行操作SetSyncing + operationId: cloudprovider_PerformSetSyncing + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderSync' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetSyncingOutput' + summary: 执行操作SetSyncing + tags: + - cloudprovider + /cloudproviders/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudprovider_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudprovider + /cloudproviders/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudprovider_GetDetailsStatus + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudprovider + post: + description: 执行操作Status + operationId: cloudprovider_PerformStatus + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudprovider + /cloudproviders/{id}/storage-classes: + get: + description: 获取指定信息StorageClasses + operationId: cloudprovider_GetDetailsStorageClasses + parameters: + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudprovider_GetDetailsStorageClassesOutput' + summary: 获取指定信息StorageClasses + tags: + - cloudprovider + /cloudproviders/{id}/sync: + post: + description: 执行操作Sync + operationId: cloudprovider_PerformSync + parameters: + - description: The Id or Name of cloudprovider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/SyncRangeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformSyncOutput' + summary: 执行操作Sync + tags: + - cloudprovider + /cloudproviders/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudprovider_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudprovider + /cloudproviders/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudprovider_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudprovider: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudprovider_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudprovider + /cloudproviders/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudprovider_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudprovider + /cloudproviders/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudprovider_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudprovider + /cloudproviders/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudprovider_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudprovider + /cloudproviders/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudprovider_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudprovider + /cloudproviders/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudprovider_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudprovider_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudprovider + /cloudregions: + get: + description: 列表 + operationId: cloudregion_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by Vpc usability of the resource + in: query + name: usable_vpc + type: boolean + x-go-name: UsableVpc + - description: 根据该云平台的功能对云账号或云订阅进行过滤 + in: query + items: + type: string + name: capability + type: array + x-go-name: Capability + - description: 过滤位于指定城市的区域 + in: query + name: city + type: string + x-go-name: City + - description: 过滤提供特定服务的区域 + in: query + name: service + type: string + x-go-name: Service + - description: 云环境 + in: query + items: + type: string + name: environment + type: array + x-go-name: Environment + - description: 按可用区数量排序 + in: query + name: order_by_zone_count + pattern: asc|desc + type: string + x-go-name: OrderByZoneCount + - description: 按vpc数量排序 + in: query + name: order_by_vpc_count + pattern: asc|desc + type: string + x-go-name: OrderByVpcCount + - description: 按虚拟机数量排序 + in: query + name: order_by_guest_count + pattern: asc|desc + type: string + x-go-name: OrderByGuestCount + responses: + "200": + $ref: '#/responses/cloudregion_ListItemFilterOutput' + summary: 云平台区域列表 + tags: + - cloudregion + post: + description: 新建 + operationId: cloudregion_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_ValidateCreateDataOutput' + summary: 新建 + tags: + - cloudregion + /cloudregions/{id}: + delete: + description: 删除 + operationId: cloudregion_CustomizeDelete + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_CustomizeDeleteOutput' + summary: 删除 + tags: + - cloudregion + get: + description: 获取详情 + operationId: cloudregion_FetchCustomizeColumns + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - cloudregion + put: + description: 更新 + operationId: cloudregion_ValidateUpdateData + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_ValidateUpdateDataOutput' + summary: 更新 + tags: + - cloudregion + /cloudregions/{id}/capability: + get: + description: 获取指定信息Capability + operationId: cloudregion_GetDetailsCapability + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsCapabilityOutput' + summary: 获取指定信息Capability + tags: + - cloudregion + /cloudregions/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: cloudregion_GetDetailsClassMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - cloudregion + post: + description: 执行操作ClassMetadata + operationId: cloudregion_PerformClassMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - cloudregion + /cloudregions/{id}/default-vpc: + post: + description: 执行操作DefaultVpc + operationId: cloudregion_PerformDefaultVpc + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_PerformDefaultVpcOutput' + summary: 执行操作DefaultVpc + tags: + - cloudregion + /cloudregions/{id}/disable: + post: + description: 执行操作Disable + operationId: cloudregion_PerformDisable + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformDisableOutput' + summary: 禁用资源 + tags: + - cloudregion + /cloudregions/{id}/disk-capability: + get: + description: 获取指定信息DiskCapability + operationId: cloudregion_GetDetailsDiskCapability + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsDiskCapabilityOutput' + summary: 获取指定信息DiskCapability + tags: + - cloudregion + /cloudregions/{id}/enable: + post: + description: 执行操作Enable + operationId: cloudregion_PerformEnable + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformEnableOutput' + summary: 启用资源 + tags: + - cloudregion + /cloudregions/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: cloudregion_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - cloudregion + /cloudregions/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: cloudregion_PerformSetClassMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - cloudregion + /cloudregions/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: cloudregion_PerformSetSchedtag + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - cloudregion + /cloudregions/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: cloudregion_PerformSetUserMetadata + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - cloudregion + /cloudregions/{id}/status: + get: + description: 获取指定信息Status + operationId: cloudregion_GetDetailsStatus + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/cloudregion_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - cloudregion + post: + description: 执行操作Status + operationId: cloudregion_PerformStatus + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformStatusOutput' + summary: 更新资源状态 + tags: + - cloudregion + /cloudregions/{id}/sync-images: + post: + description: 执行操作SyncImages + operationId: cloudregion_PerformSyncImages + parameters: + - description: The Id or Name of cloudregion + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/SyncImagesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSyncImagesOutput' + summary: 执行操作SyncImages + tags: + - cloudregion + /cloudregions/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: cloudregion_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - cloudregion + /cloudregions/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: cloudregion_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - cloudregion + /cloudregions/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: cloudregion_GetPropertySplitable + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - cloudregion + /cloudregions/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: cloudregion_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - cloudregion + /cloudregions/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: cloudregion_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - cloudregion + /cloudregions/sync-skus: + post: + description: 执行操作SyncSkus + operationId: cloudregion_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionSkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/cloudregion_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - cloudregion + /cloudregions/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: cloudregion_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - cloudregion + /cloudregions/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: cloudregion_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - cloudregion + /cloudregions/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: cloudregion_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/cloudregion_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - cloudregion + /db_instance_accounts: + get: + description: 列表 + operationId: db_instance_account_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/db_instance_account_ListItemFilterOutput' + summary: RDS账号列表 + tags: + - db_instance_account + post: + description: 新建 + operationId: db_instance_account_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_account: + $ref: '#/definitions/DBInstanceAccountCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_account + /db_instance_accounts/{id}: + delete: + description: 删除 + operationId: db_instance_account_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_account + get: + description: 获取详情 + operationId: db_instance_account_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_account + put: + description: 更新 + operationId: db_instance_account_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_account + /db_instance_accounts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_account_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_account + post: + description: 执行操作ClassMetadata + operationId: db_instance_account_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_account + /db_instance_accounts/{id}/grant-privilege: + post: + description: 执行操作GrantPrivilege + operationId: db_instance_account_PerformGrantPrivilege + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_PerformGrantPrivilegeOutput' + summary: 执行操作GrantPrivilege + tags: + - db_instance_account + /db_instance_accounts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_account_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_account + /db_instance_accounts/{id}/reset-password: + post: + description: 执行操作ResetPassword + operationId: db_instance_account_PerformResetPassword + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_PerformResetPasswordOutput' + summary: 执行操作ResetPassword + tags: + - db_instance_account + /db_instance_accounts/{id}/revoke-privilege: + post: + description: 执行操作RevokePrivilege + operationId: db_instance_account_PerformRevokePrivilege + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_PerformRevokePrivilegeOutput' + summary: 执行操作RevokePrivilege + tags: + - db_instance_account + /db_instance_accounts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_account_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_account + /db_instance_accounts/{id}/set-privileges: + post: + description: 执行操作SetPrivileges + operationId: db_instance_account_PerformSetPrivileges + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_PerformSetPrivilegesOutput' + summary: 执行操作SetPrivileges + tags: + - db_instance_account + /db_instance_accounts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_account_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_account + /db_instance_accounts/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_account_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_account_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance_account + post: + description: 执行操作Status + operationId: db_instance_account_PerformStatus + parameters: + - description: The Id or Name of db_instance_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_account: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance_account + /db_instance_accounts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_account_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_account + /db_instance_accounts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_account_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_account: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_account_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_account + /db_instance_accounts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_account_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_account + /db_instance_accounts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_account_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_account + /db_instance_accounts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_account_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance_account + /db_instance_accounts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_account_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_account + /db_instance_accounts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_account_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_account_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_account + /db_instance_backups: + get: + description: 列表 + operationId: db_instance_backup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: RDS引擎 + example: MySQL + in: query + items: + type: string + name: engine + type: array + x-go-name: Engine + - description: RDS引擎版本 + example: "5.7" + in: query + items: + type: string + name: engine_version + type: array + x-go-name: EngineVersion + - description: 备份模式 + in: query + items: + type: string + name: backup_mode + type: array + x-go-name: BackupMode + - description: 数据库名称 + in: query + name: db_names + type: string + x-go-name: DBNames + responses: + "200": + $ref: '#/responses/db_instance_backup_ListItemFilterOutput' + summary: RDS备份列表 + tags: + - db_instance_backup + post: + description: 新建 + operationId: db_instance_backup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_backup + /db_instance_backups/{id}: + delete: + description: 删除 + operationId: db_instance_backup_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_backup + get: + description: 获取详情 + operationId: db_instance_backup_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_backup + put: + description: 更新 + operationId: db_instance_backup_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_backup + /db_instance_backups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: db_instance_backup_PerformCancelDelete + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - db_instance_backup + /db_instance_backups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: db_instance_backup_PerformChangeOwner + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - db_instance_backup + /db_instance_backups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: db_instance_backup_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - db_instance_backup + /db_instance_backups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_backup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_backup + post: + description: 执行操作ClassMetadata + operationId: db_instance_backup_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_backup + /db_instance_backups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: db_instance_backup_PerformFreeze + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - db_instance_backup + /db_instance_backups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_backup_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_backup + /db_instance_backups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_backup_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_backup + /db_instance_backups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_backup_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_backup + /db_instance_backups/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_backup_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_backup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance_backup + post: + description: 执行操作Status + operationId: db_instance_backup_PerformStatus + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance_backup + /db_instance_backups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: db_instance_backup_PerformSyncstatus + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DiskSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformSyncstatusOutput' + summary: 同步RDS备份状态 + tags: + - db_instance_backup + /db_instance_backups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: db_instance_backup_PerformUnfreeze + parameters: + - description: The Id or Name of db_instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - db_instance_backup + /db_instance_backups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_backup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_backup + /db_instance_backups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: db_instance_backup_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - db_instance_backup + /db_instance_backups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: db_instance_backup_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - db_instance_backup + /db_instance_backups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: db_instance_backup_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - db_instance_backup + /db_instance_backups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: db_instance_backup_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - db_instance_backup + /db_instance_backups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_backup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_backup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_backup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_backup + /db_instance_backups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_backup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_backup + /db_instance_backups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_backup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_backup + /db_instance_backups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_backup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance_backup + /db_instance_backups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_backup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_backup + /db_instance_backups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_backup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_backup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_backup + /db_instance_databases: + get: + description: 列表 + operationId: db_instance_database_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 数据库字符集 + in: query + items: + type: string + name: character_set + type: array + x-go-name: CharacterSet + responses: + "200": + $ref: '#/responses/db_instance_database_ListItemFilterOutput' + summary: RDS数据库列表 + tags: + - db_instance_database + post: + description: 新建 + operationId: db_instance_database_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_database: + $ref: '#/definitions/DBInstanceDatabaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_database + /db_instance_databases/{id}: + delete: + description: 删除 + operationId: db_instance_database_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_database + get: + description: 获取详情 + operationId: db_instance_database_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_database + put: + description: 更新 + operationId: db_instance_database_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstanceDatabaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_database + /db_instance_databases/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_database_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_database + post: + description: 执行操作ClassMetadata + operationId: db_instance_database_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_database + /db_instance_databases/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_database_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_database + /db_instance_databases/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_database_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_database + /db_instance_databases/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_database_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_database + /db_instance_databases/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_database_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_database_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance_database + post: + description: 执行操作Status + operationId: db_instance_database_PerformStatus + parameters: + - description: The Id or Name of db_instance_database + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_database: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance_database + /db_instance_databases/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_database_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_database + /db_instance_databases/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_database_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_database: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_database_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_database + /db_instance_databases/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_database_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_database + /db_instance_databases/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_database_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_database + /db_instance_databases/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_database_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance_database + /db_instance_databases/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_database_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_database + /db_instance_databases/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_database_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_database_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_database + /db_instance_networks: + get: + description: 列表 + operationId: db_instance_network_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + responses: + "200": + $ref: '#/responses/db_instance_network_ListItemFilterOutput' + summary: RDS网络列表 + tags: + - db_instance_network + post: + description: 新建 + operationId: db_instance_network_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_network: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_network_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_network + /db_instance_networks/{id}: + delete: + description: 删除 + operationId: db_instance_network_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_network_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_network + get: + description: 获取详情 + operationId: db_instance_network_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_network_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_network + put: + description: 更新 + operationId: db_instance_network_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_network_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_network + /db_instance_networks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_network_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_network_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_network + /db_instance_networks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_network_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_network: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_network_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_network + /db_instance_networks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_network_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_network_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_network + /db_instance_networks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_network_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_network_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_network + /db_instance_parameters: + get: + description: 列表 + operationId: db_instance_parameter_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 参数名称 + in: query + items: + type: string + name: key + type: array + x-go-name: Key + - description: 参数值 + in: query + items: + type: string + name: value + type: array + x-go-name: Value + responses: + "200": + $ref: '#/responses/db_instance_parameter_ListItemFilterOutput' + summary: 列出数据参数 + tags: + - db_instance_parameter + post: + description: 新建 + operationId: db_instance_parameter_ValidateCreateData + responses: + "200": + $ref: '#/responses/db_instance_parameter_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_parameter + /db_instance_parameters/{id}: + delete: + description: 删除 + operationId: db_instance_parameter_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_parameter + get: + description: 获取详情 + operationId: db_instance_parameter_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_parameter + put: + description: 更新 + operationId: db_instance_parameter_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_parameter + /db_instance_parameters/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_parameter_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_parameter + post: + description: 执行操作ClassMetadata + operationId: db_instance_parameter_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_parameter + /db_instance_parameters/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_parameter_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_parameter + /db_instance_parameters/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_parameter_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_parameter + /db_instance_parameters/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_parameter_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_parameter + /db_instance_parameters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_parameter_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_parameter + /db_instance_parameters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_parameter_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_parameter_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_parameter + /db_instance_parameters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_parameter_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_parameter + /db_instance_parameters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_parameter_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_parameter + /db_instance_parameters/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_parameter_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_parameter + /db_instance_parameters/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_parameter_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_parameter_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_parameter + /db_instance_privileges: + get: + description: 列表 + operationId: db_instance_privilege_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: filter by dbinstanceaccount + in: query + name: dbinstanceaccount + type: string + x-go-name: Dbinstanceaccount + - description: filter by dbinstancedatabase + in: query + name: dbinstancedatabase + type: string + x-go-name: Dbinstancedatabase + - description: 权限 + in: query + items: + type: string + name: privilege + type: array + x-go-name: Privilege + responses: + "200": + $ref: '#/responses/db_instance_privilege_ListItemFilterOutput' + summary: 列表 + tags: + - db_instance_privilege + post: + description: 新建 + operationId: db_instance_privilege_ValidateCreateData + responses: + "200": + $ref: '#/responses/db_instance_privilege_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_privilege + /db_instance_privileges/{id}: + delete: + description: 删除 + operationId: db_instance_privilege_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_privilege + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_privilege_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_privilege + get: + description: 获取详情 + operationId: db_instance_privilege_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_privilege + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_privilege_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_privilege + put: + description: 更新 + operationId: db_instance_privilege_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_privilege + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_privilege_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_privilege + /db_instance_privileges/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_privilege_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_privilege_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_privilege + /db_instance_privileges/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_privilege_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_privilege_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_privilege + /db_instance_privileges/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_privilege_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_privilege_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_privilege + /db_instance_privileges/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_privilege_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_privilege_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_privilege + /db_instance_secgroups: + get: + description: 列表 + operationId: db_instance_secgroup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 以RDS实例名字排序 + in: query + name: order_by_dbinstance + type: string + x-go-name: OrderByDBInstance + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + responses: + "200": + $ref: '#/responses/db_instance_secgroup_ListItemFilterOutput' + summary: 列表 + tags: + - db_instance_secgroup + post: + description: 新建 + operationId: db_instance_secgroup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_secgroup: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_secgroup_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_secgroup + /db_instance_secgroups/{id}: + delete: + description: 删除 + operationId: db_instance_secgroup_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_secgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_secgroup_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_secgroup + get: + description: 获取详情 + operationId: db_instance_secgroup_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_secgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_secgroup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_secgroup + put: + description: 更新 + operationId: db_instance_secgroup_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_secgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_secgroup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_secgroup + /db_instance_secgroups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_secgroup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_secgroup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_secgroup + /db_instance_secgroups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_secgroup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_secgroup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_secgroup + /db_instance_secgroups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_secgroup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_secgroup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_secgroup + /db_instance_secgroups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_secgroup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_secgroup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_secgroup + /db_instance_skus: + get: + description: 列表 + operationId: db_instance_sku_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: StorageType + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - in: query + items: + format: int64 + type: integer + name: vcpu_count + type: array + x-go-name: VcpuCount + - in: query + items: + format: int64 + type: integer + name: vmem_size_mb + type: array + x-go-name: VmemSizeMb + - in: query + items: + type: string + name: category + type: array + x-go-name: Category + - in: query + items: + type: string + name: engine + type: array + x-go-name: Engine + - in: query + items: + type: string + name: engine_version + type: array + x-go-name: EngineVersion + - in: query + items: + type: string + name: zone1 + type: array + x-go-name: Zone1 + - in: query + items: + type: string + name: zone2 + type: array + x-go-name: Zone2 + - in: query + items: + type: string + name: zone3 + type: array + x-go-name: Zone3 + responses: + "200": + $ref: '#/responses/db_instance_sku_ListItemFilterOutput' + summary: RDS套餐类型列表 + tags: + - db_instance_sku + post: + description: 新建 + operationId: db_instance_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance_sku + /db_instance_skus/{id}: + delete: + description: 删除 + operationId: db_instance_sku_CustomizeDelete + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance_sku + get: + description: 获取详情 + operationId: db_instance_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance_sku + put: + description: 更新 + operationId: db_instance_sku_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance_sku + /db_instance_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance_sku + post: + description: 执行操作ClassMetadata + operationId: db_instance_sku_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance_sku + /db_instance_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: db_instance_sku_PerformDisable + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - db_instance_sku + /db_instance_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: db_instance_sku_PerformEnable + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - db_instance_sku + /db_instance_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_sku_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance_sku + /db_instance_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance_sku + /db_instance_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance_sku + /db_instance_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_sku_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance_sku + post: + description: 执行操作Status + operationId: db_instance_sku_PerformStatus + parameters: + - description: The Id or Name of db_instance_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance_sku + /db_instance_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance_sku + /db_instance_skus/instance-specs: + get: + description: 获取指定资源类的信息InstanceSpecs + operationId: db_instance_sku_GetPropertyInstanceSpecs + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyInstanceSpecsOutput' + summary: 获取指定资源类的信息InstanceSpecs + tags: + - db_instance_sku + /db_instance_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance_sku + /db_instance_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance_sku + /db_instance_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_sku_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance_sku + /db_instance_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance_sku + /db_instance_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: db_instance_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + db_instance_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - db_instance_sku + /db_instance_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: db_instance_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - db_instance_sku + /db_instance_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance_sku + /db_instance_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance_sku + /db_instances: + get: + description: 列表 + operationId: db_instance_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - in: query + name: master_instance + type: string + x-go-name: MasterInstance + - format: int64 + in: query + name: vcpu_count + type: integer + x-go-name: VcpuCount + - format: int64 + in: query + name: vmem_size_mb + type: integer + x-go-name: VmemSizeMb + - in: query + name: storage_type + type: string + x-go-name: StorageType + - in: query + name: category + type: string + x-go-name: Category + - in: query + name: engine + type: string + x-go-name: Engine + - in: query + name: engine_version + type: string + x-go-name: EngineVersion + - in: query + name: instance_type + type: string + x-go-name: InstanceType + - description: 通过IP搜索RDS实例 + in: query + name: ip_addr + type: string + x-go-name: IpAddr + responses: + "200": + $ref: '#/responses/db_instance_ListItemFilterOutput' + summary: RDS实例列表 + tags: + - db_instance + post: + description: 新建 + operationId: db_instance_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + db_instance: + $ref: '#/definitions/DBInstanceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_ValidateCreateDataOutput' + summary: 新建 + tags: + - db_instance + /db_instances/{id}: + delete: + description: 删除 + operationId: db_instance_CustomizeDelete + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_CustomizeDeleteOutput' + summary: 删除 + tags: + - db_instance + get: + description: 获取详情 + operationId: db_instance_FetchCustomizeColumns + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - db_instance + put: + description: 更新 + operationId: db_instance_ValidateUpdateData + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_ValidateUpdateDataOutput' + summary: 更新 + tags: + - db_instance + /db_instances/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: db_instance_PerformCancelDelete + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - db_instance + /db_instances/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: db_instance_PerformCancelExpire + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - db_instance + /db_instances/{id}/change-config: + post: + description: 执行操作ChangeConfig + operationId: db_instance_PerformChangeConfig + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/SDBInstanceChangeConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformChangeConfigOutput' + summary: 执行操作ChangeConfig + tags: + - db_instance + /db_instances/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: db_instance_PerformChangeOwner + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - db_instance + /db_instances/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: db_instance_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - db_instance + /db_instances/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: db_instance_GetDetailsClassMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - db_instance + post: + description: 执行操作ClassMetadata + operationId: db_instance_PerformClassMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - db_instance + /db_instances/{id}/freeze: + post: + description: 执行操作Freeze + operationId: db_instance_PerformFreeze + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - db_instance + /db_instances/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: db_instance_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - db_instance + /db_instances/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: db_instance_PerformPostpaidExpire + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - db_instance + /db_instances/{id}/public-connection: + post: + description: 执行操作PublicConnection + operationId: db_instance_PerformPublicConnection + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformPublicConnectionOutput' + summary: 执行操作PublicConnection + tags: + - db_instance + /db_instances/{id}/purge: + post: + description: 执行操作Purge + operationId: db_instance_PerformPurge + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - db_instance + /db_instances/{id}/reboot: + post: + description: 执行操作Reboot + operationId: db_instance_PerformReboot + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformRebootOutput' + summary: 执行操作Reboot + tags: + - db_instance + /db_instances/{id}/recovery: + post: + description: 执行操作Recovery + operationId: db_instance_PerformRecovery + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/SDBInstanceRecoveryConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformRecoveryOutput' + summary: 执行操作Recovery + tags: + - db_instance + /db_instances/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: db_instance_PerformRemoteUpdate + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - db_instance + /db_instances/{id}/renew: + post: + description: 执行操作Renew + operationId: db_instance_PerformRenew + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformRenewOutput' + summary: 执行操作Renew + tags: + - db_instance + /db_instances/{id}/set-auto-renew: + post: + description: |- + 要求RDS状态为running + 要求RDS计费类型为包年包月(预付费) + operationId: db_instance_PerformSetAutoRenew + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceAutoRenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetAutoRenewOutput' + summary: 设置自动续费 + tags: + - db_instance + /db_instances/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: db_instance_PerformSetClassMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - db_instance + /db_instances/{id}/set-secgroup: + post: + description: 执行操作SetSecgroup + operationId: db_instance_PerformSetSecgroup + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceSetSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetSecgroupOutput' + summary: 执行操作SetSecgroup + tags: + - db_instance + /db_instances/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: db_instance_PerformSetUserMetadata + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - db_instance + /db_instances/{id}/status: + get: + description: 获取指定信息Status + operationId: db_instance_GetDetailsStatus + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - db_instance + post: + description: 执行操作Status + operationId: db_instance_PerformStatus + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformStatusOutput' + summary: 更新资源状态 + tags: + - db_instance + /db_instances/{id}/sync: + post: + description: 执行操作Sync + operationId: db_instance_PerformSync + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformSyncOutput' + summary: 同步RDS信息 + tags: + - db_instance + /db_instances/{id}/sync-status: + post: + description: 执行操作SyncStatus + operationId: db_instance_PerformSyncStatus + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformSyncStatusOutput' + summary: 同步RDS状态(弃用) + tags: + - db_instance + /db_instances/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: db_instance_PerformSyncstatus + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/db_instance_PerformSyncstatusOutput' + summary: 同步RDS实例状态 + tags: + - db_instance + /db_instances/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: db_instance_PerformUnfreeze + parameters: + - description: The Id or Name of db_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - db_instance + /db_instances/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: db_instance_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - db_instance + /db_instances/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: db_instance_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - db_instance + /db_instances/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: db_instance_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - db_instance + /db_instances/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: db_instance_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - db_instance + /db_instances/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: db_instance_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - db_instance + /db_instances/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: db_instance_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + db_instance: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/db_instance_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - db_instance + /db_instances/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: db_instance_GetPropertySplitable + responses: + "200": + $ref: '#/responses/db_instance_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - db_instance + /db_instances/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: db_instance_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/db_instance_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - db_instance + /db_instances/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: db_instance_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - db_instance + /db_instances/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: db_instance_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - db_instance + /db_instances/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: db_instance_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/db_instance_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - db_instance + /disk_backups: + get: + description: 列表 + operationId: disk_backup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 'description: disk id' + in: query + name: disk_id + type: string + x-go-name: DiskId + - description: 'description: backup storage id' + in: query + name: backup_storage_id + type: string + x-go-name: BackupStorageId + - description: 'description: 是否为主机备份的一部分' + in: query + name: is_instance_backup + type: boolean + x-go-name: IsInstanceBackup + - description: 按硬盘名称排序 + in: query + name: order_by_disk_name + type: string + x-go-name: OrderByDiskName + responses: + "200": + $ref: '#/responses/disk_backup_ListItemFilterOutput' + summary: 列表 + tags: + - disk_backup + post: + description: 新建 + operationId: disk_backup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + disk_backup: + $ref: '#/definitions/DiskBackupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_ValidateCreateDataOutput' + summary: 新建 + tags: + - disk_backup + /disk_backups/{id}: + delete: + description: 删除 + operationId: disk_backup_CustomizeDelete + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_CustomizeDeleteOutput' + summary: 删除 + tags: + - disk_backup + get: + description: 获取详情 + operationId: disk_backup_FetchCustomizeColumns + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - disk_backup + put: + description: 更新 + operationId: disk_backup_ValidateUpdateData + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - disk_backup + /disk_backups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: disk_backup_PerformCancelDelete + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - disk_backup + /disk_backups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: disk_backup_PerformChangeOwner + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - disk_backup + /disk_backups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: disk_backup_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - disk_backup + /disk_backups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: disk_backup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - disk_backup + post: + description: 执行操作ClassMetadata + operationId: disk_backup_PerformClassMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - disk_backup + /disk_backups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: disk_backup_PerformFreeze + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - disk_backup + /disk_backups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: disk_backup_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - disk_backup + /disk_backups/{id}/recovery: + post: + description: 执行操作Recovery + operationId: disk_backup_PerformRecovery + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupRecoveryInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformRecoveryOutput' + summary: 执行操作Recovery + tags: + - disk_backup + /disk_backups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: disk_backup_PerformSetClassMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - disk_backup + /disk_backups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: disk_backup_PerformSetUserMetadata + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - disk_backup + /disk_backups/{id}/status: + get: + description: 获取指定信息Status + operationId: disk_backup_GetDetailsStatus + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_backup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - disk_backup + post: + description: 执行操作Status + operationId: disk_backup_PerformStatus + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - disk_backup + /disk_backups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: disk_backup_PerformSyncstatus + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - disk_backup + /disk_backups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: disk_backup_PerformUnfreeze + parameters: + - description: The Id or Name of disk_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - disk_backup + /disk_backups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: disk_backup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - disk_backup + /disk_backups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: disk_backup_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - disk_backup + /disk_backups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: disk_backup_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - disk_backup + /disk_backups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: disk_backup_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - disk_backup + /disk_backups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: disk_backup_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - disk_backup + /disk_backups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: disk_backup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + disk_backup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_backup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - disk_backup + /disk_backups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: disk_backup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - disk_backup + /disk_backups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: disk_backup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - disk_backup + /disk_backups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: disk_backup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - disk_backup + /disk_backups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: disk_backup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - disk_backup + /disk_backups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: disk_backup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/disk_backup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - disk_backup + /disks: + get: + description: 列表 + operationId: disk_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + name: os_arch + type: string + x-go-name: OsArch + - in: query + name: AutoDelete + type: boolean + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: filter disk by snapshotpolicy + in: query + name: snapshotpolicy_id + type: string + x-go-name: SnapshotpolicyId + - description: 以快照策略名称排序 + in: query + name: order_by_snapshotpolicy + type: string + x-go-name: OrderBySnapshotpolicy + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: filter disk by whether it is being used + in: query + name: unused + type: boolean + x-go-name: Unused + - description: |- + 过滤指定disk_type的磁盘列表，可能的值为：sys, data, swap. volume + + disk_type值 | 说明 | + -------------|----------| + sys | 虚拟机系统盘 | + data | 虚拟机数据盘 | + swap | 虚拟机内存交换盘 | + volume | 容器volumn盘 | + in: query + name: disk_type + type: string + x-go-name: DiskType + - in: query + name: disk_format + type: string + x-go-name: DiskFormat + - format: int64 + in: query + name: disk_size + type: integer + x-go-name: DiskSize + - in: query + name: fs_format + type: string + x-go-name: FsFormat + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - in: query + name: order_by_guest_count + type: string + x-go-name: OrderByGuestCount + - description: 镜像 + in: query + name: image_id + type: string + x-go-name: ImageId + - description: 快照 + in: query + name: snapshot_id + type: string + x-go-name: SnapshotId + responses: + "200": + $ref: '#/responses/disk_ListItemFilterOutput' + summary: 磁盘列表 + tags: + - disk + post: + description: 新建 + operationId: disk_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + disk: + $ref: '#/definitions/DiskCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_ValidateCreateDataOutput' + summary: 新建 + tags: + - disk + /disks/{id}: + delete: + description: 删除 + operationId: disk_CustomizeDelete + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_CustomizeDeleteOutput' + summary: 删除 + tags: + - disk + get: + description: 获取详情 + operationId: disk_FetchCustomizeColumns + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - disk + put: + description: 更新 + operationId: disk_ValidateUpdateData + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_ValidateUpdateDataOutput' + summary: 更新 + tags: + - disk + /disks/{id}/bind-snapshotpolicy: + post: + description: 执行操作BindSnapshotpolicy + operationId: disk_PerformBindSnapshotpolicy + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_PerformBindSnapshotpolicyOutput' + summary: 执行操作BindSnapshotpolicy + tags: + - disk + /disks/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: disk_PerformCancelDelete + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - disk + /disks/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: disk_PerformChangeOwner + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - disk + /disks/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: disk_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - disk + /disks/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: disk_GetDetailsClassMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - disk + post: + description: 执行操作ClassMetadata + operationId: disk_PerformClassMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - disk + /disks/{id}/convert-snapshot: + get: + description: 获取指定信息ConvertSnapshot + operationId: disk_GetDetailsConvertSnapshot + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsConvertSnapshotOutput' + summary: 获取指定信息ConvertSnapshot + tags: + - disk + /disks/{id}/disk-reset: + post: + description: 执行操作DiskReset + operationId: disk_PerformDiskReset + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskResetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformDiskResetOutput' + summary: 执行操作DiskReset + tags: + - disk + /disks/{id}/freeze: + post: + description: 执行操作Freeze + operationId: disk_PerformFreeze + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - disk + /disks/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: disk_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - disk + /disks/{id}/purge: + post: + description: 执行操作Purge + operationId: disk_PerformPurge + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - disk + /disks/{id}/resize: + post: + description: 执行操作Resize + operationId: disk_PerformResize + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskResizeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformResizeOutput' + summary: 执行操作Resize + tags: + - disk + /disks/{id}/save: + post: + description: 执行操作Save + operationId: disk_PerformSave + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskSaveInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSaveOutput' + summary: 执行操作Save + tags: + - disk + /disks/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: disk_PerformSetClassMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - disk + /disks/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: disk_PerformSetUserMetadata + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - disk + /disks/{id}/status: + get: + description: 获取指定信息Status + operationId: disk_GetDetailsStatus + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - disk + post: + description: 执行操作Status + operationId: disk_PerformStatus + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformStatusOutput' + summary: 更新资源状态 + tags: + - disk + /disks/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: disk_PerformSyncstatus + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/DiskSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformSyncstatusOutput' + summary: 同步磁盘状态 + tags: + - disk + /disks/{id}/unbind-snapshotpolicy: + post: + description: 执行操作UnbindSnapshotpolicy + operationId: disk_PerformUnbindSnapshotpolicy + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/disk_PerformUnbindSnapshotpolicyOutput' + summary: 执行操作UnbindSnapshotpolicy + tags: + - disk + /disks/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: disk_PerformUnfreeze + parameters: + - description: The Id or Name of disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - disk + /disks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: disk_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/disk_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - disk + /disks/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: disk_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/disk_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - disk + /disks/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: disk_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/disk_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - disk + /disks/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: disk_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/disk_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - disk + /disks/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: disk_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/disk_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - disk + /disks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: disk_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + disk: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/disk_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - disk + /disks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: disk_GetPropertySplitable + responses: + "200": + $ref: '#/responses/disk_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - disk + /disks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: disk_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/disk_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - disk + /disks/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: disk_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/disk_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - disk + /disks/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: disk_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/disk_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - disk + /disks/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: disk_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/disk_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - disk + /dns_record_set_traffic_policies: + get: + description: 列表 + operationId: dns_record_set_traffic_policy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_ListItemFilterOutput' + summary: 列表 + tags: + - dns_record_set_traffic_policy + post: + description: 新建 + operationId: dns_record_set_traffic_policy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_record_set_traffic_policy: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_ValidateCreateDataOutput' + summary: 新建 + tags: + - dns_record_set_traffic_policy + /dns_record_set_traffic_policies/{id}: + delete: + description: 删除 + operationId: dns_record_set_traffic_policy_CustomizeDelete + parameters: + - description: The Id or Name of dns_record_set_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_record_set_traffic_policy + get: + description: 获取详情 + operationId: dns_record_set_traffic_policy_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_record_set_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - dns_record_set_traffic_policy + put: + description: 更新 + operationId: dns_record_set_traffic_policy_ValidateUpdateData + parameters: + - description: The Id or Name of dns_record_set_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record_set_traffic_policy: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_record_set_traffic_policy + /dns_record_set_traffic_policies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_record_set_traffic_policy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_record_set_traffic_policy + /dns_record_set_traffic_policies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_record_set_traffic_policy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_record_set_traffic_policy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_record_set_traffic_policy + /dns_record_set_traffic_policies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_record_set_traffic_policy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_record_set_traffic_policy + /dns_record_set_traffic_policies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_record_set_traffic_policy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/dns_record_set_traffic_policy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_record_set_traffic_policy + /dns_records: + get: + description: 列表 + operationId: dns_record_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + responses: + "200": + $ref: '#/responses/dns_record_ListItemFilterOutput' + summary: 域名记录列表 + tags: + - dns_record + post: + description: 新建 + operationId: dns_record_ValidateCreateData + responses: + "200": + $ref: '#/responses/dns_record_ValidateCreateDataOutput' + summary: 新建 + tags: + - dns_record + /dns_records/{id}: + delete: + description: 删除 + operationId: dns_record_CustomizeDelete + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_record + get: + description: 获取详情 + operationId: dns_record_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - dns_record + put: + description: 更新 + operationId: dns_record_ValidateUpdateData + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_record + /dns_records/{id}/add-records: + post: + description: 执行操作AddRecords + operationId: dns_record_PerformAddRecords + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_PerformAddRecordsOutput' + summary: 执行操作AddRecords + tags: + - dns_record + /dns_records/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: dns_record_PerformCancelDelete + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - dns_record + /dns_records/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: dns_record_PerformChangeOwner + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - dns_record + /dns_records/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: dns_record_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - dns_record + /dns_records/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dns_record_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dns_record + post: + description: 执行操作ClassMetadata + operationId: dns_record_PerformClassMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dns_record + /dns_records/{id}/disable: + post: + description: 执行操作Disable + operationId: dns_record_PerformDisable + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformDisableOutput' + summary: 执行操作Disable + tags: + - dns_record + /dns_records/{id}/enable: + post: + description: 执行操作Enable + operationId: dns_record_PerformEnable + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformEnableOutput' + summary: 执行操作Enable + tags: + - dns_record + /dns_records/{id}/freeze: + post: + description: 执行操作Freeze + operationId: dns_record_PerformFreeze + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - dns_record + /dns_records/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dns_record_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dns_record + /dns_records/{id}/private: + post: + description: 执行操作Private + operationId: dns_record_PerformPrivate + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformPrivateOutput' + summary: 执行操作Private + tags: + - dns_record + /dns_records/{id}/public: + post: + description: 执行操作Public + operationId: dns_record_PerformPublic + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformPublicOutput' + summary: 执行操作Public + tags: + - dns_record + /dns_records/{id}/remove-records: + post: + description: 执行操作RemoveRecords + operationId: dns_record_PerformRemoveRecords + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_PerformRemoveRecordsOutput' + summary: 执行操作RemoveRecords + tags: + - dns_record + /dns_records/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dns_record_PerformSetClassMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_record + /dns_records/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dns_record_PerformSetUserMetadata + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dns_record + /dns_records/{id}/status: + get: + description: 获取指定信息Status + operationId: dns_record_GetDetailsStatus + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_record_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - dns_record + post: + description: 执行操作Status + operationId: dns_record_PerformStatus + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformStatusOutput' + summary: 更新资源状态 + tags: + - dns_record + /dns_records/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: dns_record_PerformUnfreeze + parameters: + - description: The Id or Name of dns_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - dns_record + /dns_records/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_record_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_record + /dns_records/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: dns_record_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - dns_record + /dns_records/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: dns_record_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - dns_record + /dns_records/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: dns_record_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - dns_record + /dns_records/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: dns_record_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - dns_record + /dns_records/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_record_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_record: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_record_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_record + /dns_records/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_record_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_record_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_record + /dns_records/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_record_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/dns_record_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_record + /dns_records/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: dns_record_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - dns_record + /dns_records/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dns_record_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dns_record + /dns_records/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dns_record_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dns_record_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dns_record + /dns_recordsets: + get: + description: 列表 + operationId: dns_recordset_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - in: query + name: dns_zone_id + type: string + x-go-name: DnsZoneId + responses: + "200": + $ref: '#/responses/dns_recordset_ListItemFilterOutput' + summary: DNS记录列表 + tags: + - dns_recordset + post: + description: 新建 + operationId: dns_recordset_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_recordset: + $ref: '#/definitions/DnsRecordSetCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_ValidateCreateDataOutput' + summary: 创建 + tags: + - dns_recordset + /dns_recordsets/{id}: + delete: + description: 删除 + operationId: dns_recordset_CustomizeDelete + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_recordset_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_recordset + get: + description: 获取详情 + operationId: dns_recordset_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_recordset_FetchCustomizeColumnsOutput' + summary: 解析详情 + tags: + - dns_recordset + put: + description: 更新 + operationId: dns_recordset_ValidateUpdateData + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_recordset: + $ref: '#/definitions/DnsRecordSetUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_recordset + /dns_recordsets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dns_recordset_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_recordset_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dns_recordset + post: + description: 执行操作ClassMetadata + operationId: dns_recordset_PerformClassMetadata + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_recordset: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dns_recordset + /dns_recordsets/{id}/disable: + post: + description: 执行操作Disable + operationId: dns_recordset_PerformDisable + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_recordset: + $ref: '#/definitions/DnsRecordDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_PerformDisableOutput' + summary: 禁用 + tags: + - dns_recordset + /dns_recordsets/{id}/enable: + post: + description: 执行操作Enable + operationId: dns_recordset_PerformEnable + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_recordset: + $ref: '#/definitions/DnsRecordEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_PerformEnableOutput' + summary: 启用 + tags: + - dns_recordset + /dns_recordsets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dns_recordset_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_recordset_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dns_recordset + /dns_recordsets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dns_recordset_PerformSetClassMetadata + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_recordset: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_recordset + /dns_recordsets/{id}/set-traffic-policies: + post: + description: 执行操作SetTrafficPolicies + operationId: dns_recordset_PerformSetTrafficPolicies + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_recordset: + $ref: '#/definitions/DnsRecordSetTrafficPoliciesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_PerformSetTrafficPoliciesOutput' + summary: 设置流量策略 + tags: + - dns_recordset + /dns_recordsets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dns_recordset_PerformSetUserMetadata + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_recordset: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dns_recordset + /dns_recordsets/{id}/status: + get: + description: 获取指定信息Status + operationId: dns_recordset_GetDetailsStatus + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_recordset_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - dns_recordset + post: + description: 执行操作Status + operationId: dns_recordset_PerformStatus + parameters: + - description: The Id or Name of dns_recordset + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_recordset: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_PerformStatusOutput' + summary: 更新资源状态 + tags: + - dns_recordset + /dns_recordsets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_recordset_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_recordset_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_recordset + /dns_recordsets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_recordset_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_recordset: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_recordset_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_recordset + /dns_recordsets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_recordset_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_recordset_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_recordset + /dns_recordsets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_recordset_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/dns_recordset_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_recordset + /dns_recordsets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: dns_recordset_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/dns_recordset_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - dns_recordset + /dns_recordsets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dns_recordset_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dns_recordset_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dns_recordset + /dns_recordsets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dns_recordset_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dns_recordset_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dns_recordset + /dns_traffic_policies: + get: + description: 列表 + operationId: dns_traffic_policy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - in: query + items: + type: string + name: provider + type: array + x-go-name: Provider + - in: query + name: policy_type + type: string + x-go-name: PolicyType + responses: + "200": + $ref: '#/responses/dns_traffic_policy_ListItemFilterOutput' + summary: 列表 + tags: + - dns_traffic_policy + post: + description: 新建 + operationId: dns_traffic_policy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_traffic_policy: + $ref: '#/definitions/DnsTrafficPolicyCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_ValidateCreateDataOutput' + summary: 创建 + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}: + delete: + description: 删除 + operationId: dns_traffic_policy_CustomizeDelete + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_traffic_policy_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_traffic_policy + get: + description: 获取详情 + operationId: dns_traffic_policy_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_traffic_policy_FetchCustomizeColumnsOutput' + summary: 详情 + tags: + - dns_traffic_policy + put: + description: 更新 + operationId: dns_traffic_policy_ValidateUpdateData + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: dns_traffic_policy_PerformChangeOwner + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: dns_traffic_policy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dns_traffic_policy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dns_traffic_policy + post: + description: 执行操作ClassMetadata + operationId: dns_traffic_policy_PerformClassMetadata + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/disable: + post: + description: 执行操作Disable + operationId: dns_traffic_policy_PerformDisable + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformDisableOutput' + summary: 禁用资源 + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/enable: + post: + description: 执行操作Enable + operationId: dns_traffic_policy_PerformEnable + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformEnableOutput' + summary: 启用资源 + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dns_traffic_policy_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/private: + post: + description: 执行操作Private + operationId: dns_traffic_policy_PerformPrivate + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformPrivateOutput' + summary: 执行操作Private + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/public: + post: + description: 执行操作Public + operationId: dns_traffic_policy_PerformPublic + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformPublicOutput' + summary: 执行操作Public + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dns_traffic_policy_PerformSetClassMetadata + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dns_traffic_policy_PerformSetUserMetadata + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dns_traffic_policy + /dns_traffic_policies/{id}/status: + get: + description: 获取指定信息Status + operationId: dns_traffic_policy_GetDetailsStatus + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - dns_traffic_policy + post: + description: 执行操作Status + operationId: dns_traffic_policy_PerformStatus + parameters: + - description: The Id or Name of dns_traffic_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformStatusOutput' + summary: 更新资源状态 + tags: + - dns_traffic_policy + /dns_traffic_policies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_traffic_policy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_traffic_policy + /dns_traffic_policies/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: dns_traffic_policy_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - dns_traffic_policy + /dns_traffic_policies/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: dns_traffic_policy_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - dns_traffic_policy + /dns_traffic_policies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_traffic_policy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_traffic_policy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_traffic_policy + /dns_traffic_policies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_traffic_policy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_traffic_policy + /dns_traffic_policies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_traffic_policy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_traffic_policy + /dns_traffic_policies/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: dns_traffic_policy_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - dns_traffic_policy + /dns_traffic_policies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dns_traffic_policy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dns_traffic_policy + /dns_traffic_policies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dns_traffic_policy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dns_traffic_policy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dns_traffic_policy + /dns_zone_caches: + get: + description: 列表 + operationId: dns_zone_cache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - in: query + name: dns_zone_id + type: string + x-go-name: DnsZoneId + - in: query + name: cloudaccount_id + type: string + x-go-name: CloudaccountId + responses: + "200": + $ref: '#/responses/dns_zone_cache_ListItemFilterOutput' + summary: 列表 + tags: + - dns_zone_cache + post: + description: 新建 + operationId: dns_zone_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_zone_cache: + $ref: '#/definitions/DnsZoneCacheCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - dns_zone_cache + /dns_zone_caches/{id}: + delete: + description: 删除 + operationId: dns_zone_cache_CustomizeDelete + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_zone_cache + get: + description: 获取详情 + operationId: dns_zone_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - dns_zone_cache + put: + description: 更新 + operationId: dns_zone_cache_ValidateUpdateData + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_zone_cache + /dns_zone_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dns_zone_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dns_zone_cache + post: + description: 执行操作ClassMetadata + operationId: dns_zone_cache_PerformClassMetadata + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dns_zone_cache + /dns_zone_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dns_zone_cache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dns_zone_cache + /dns_zone_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dns_zone_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_zone_cache + /dns_zone_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dns_zone_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dns_zone_cache + /dns_zone_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: dns_zone_cache_GetDetailsStatus + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - dns_zone_cache + post: + description: 执行操作Status + operationId: dns_zone_cache_PerformStatus + parameters: + - description: The Id or Name of dns_zone_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - dns_zone_cache + /dns_zone_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_zone_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_zone_cache + /dns_zone_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_zone_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_zone_cache + /dns_zone_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_zone_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_zone_cache + /dns_zone_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_zone_cache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_zone_cache + /dns_zone_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: dns_zone_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - dns_zone_cache + /dns_zone_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dns_zone_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dns_zone_cache + /dns_zone_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dns_zone_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dns_zone_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dns_zone_cache + /dns_zone_vpcs: + get: + description: 列表 + operationId: dns_zone_vpc_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/dns_zone_vpc_ListItemFilterOutput' + summary: 列表 + tags: + - dns_zone_vpc + post: + description: 新建 + operationId: dns_zone_vpc_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_zone_vpc: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_vpc_ValidateCreateDataOutput' + summary: 新建 + tags: + - dns_zone_vpc + /dns_zone_vpcs/{id}: + delete: + description: 删除 + operationId: dns_zone_vpc_CustomizeDelete + parameters: + - description: The Id or Name of dns_zone_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_vpc_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_zone_vpc + get: + description: 获取详情 + operationId: dns_zone_vpc_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_zone_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_vpc_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - dns_zone_vpc + put: + description: 更新 + operationId: dns_zone_vpc_ValidateUpdateData + parameters: + - description: The Id or Name of dns_zone_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_vpc_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_zone_vpc + /dns_zone_vpcs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_zone_vpc_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_zone_vpc_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_zone_vpc + /dns_zone_vpcs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_zone_vpc_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_vpc_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_zone_vpc + /dns_zone_vpcs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_zone_vpc_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_zone_vpc_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_zone_vpc + /dns_zone_vpcs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_zone_vpc_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/dns_zone_vpc_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_zone_vpc + /dns_zones: + get: + description: 列表 + operationId: dns_zone_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: |- + 区域类型 + + + 类型 | 说明 | + ---------- |---------| + PublicZone | 公有 | + PrivateZone | 私有 | + in: query + name: zone_type + type: string + x-go-name: ZoneType + - description: Filter dns zone By vpc + in: query + name: vpc_id + type: string + x-go-name: VpcId + - in: query + name: with_cache + type: boolean + x-go-name: WithCache + responses: + "200": + $ref: '#/responses/dns_zone_ListItemFilterOutput' + summary: 列表 + tags: + - dns_zone + post: + description: 新建 + operationId: dns_zone_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + dns_zone: + $ref: '#/definitions/DnsZoneCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_ValidateCreateDataOutput' + summary: 创建 + tags: + - dns_zone + /dns_zones/{id}: + delete: + description: 删除 + operationId: dns_zone_CustomizeDelete + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_CustomizeDeleteOutput' + summary: 删除 + tags: + - dns_zone + get: + description: 获取详情 + operationId: dns_zone_FetchCustomizeColumns + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_FetchCustomizeColumnsOutput' + summary: 解析详情 + tags: + - dns_zone + put: + description: 更新 + operationId: dns_zone_ValidateUpdateData + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dns_zone + /dns_zones/{id}/add-vpcs: + post: + description: 执行操作AddVpcs + operationId: dns_zone_PerformAddVpcs + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneAddVpcsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformAddVpcsOutput' + summary: 添加VPC + tags: + - dns_zone + /dns_zones/{id}/cache: + post: + description: 执行操作Cache + operationId: dns_zone_PerformCache + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneCacheInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformCacheOutput' + summary: 指定云账号创建 + tags: + - dns_zone + /dns_zones/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: dns_zone_PerformChangeOwner + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - dns_zone + /dns_zones/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: dns_zone_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - dns_zone + /dns_zones/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dns_zone_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dns_zone + post: + description: 执行操作ClassMetadata + operationId: dns_zone_PerformClassMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dns_zone + /dns_zones/{id}/disable: + post: + description: 执行操作Disable + operationId: dns_zone_PerformDisable + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformDisableOutput' + summary: 禁用资源 + tags: + - dns_zone + /dns_zones/{id}/enable: + post: + description: 执行操作Enable + operationId: dns_zone_PerformEnable + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformEnableOutput' + summary: 启用资源 + tags: + - dns_zone + /dns_zones/{id}/exports: + get: + description: 获取指定信息Exports + operationId: dns_zone_GetDetailsExports + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsExportsOutput' + summary: 获取指定信息Exports + tags: + - dns_zone + /dns_zones/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dns_zone_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dns_zone + /dns_zones/{id}/private: + post: + description: 执行操作Private + operationId: dns_zone_PerformPrivate + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformPrivateOutput' + summary: 执行操作Private + tags: + - dns_zone + /dns_zones/{id}/public: + post: + description: 执行操作Public + operationId: dns_zone_PerformPublic + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformPublicOutput' + summary: 执行操作Public + tags: + - dns_zone + /dns_zones/{id}/purge: + post: + description: 执行操作Purge + operationId: dns_zone_PerformPurge + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZonePurgeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - dns_zone + /dns_zones/{id}/remove-vpcs: + post: + description: 执行操作RemoveVpcs + operationId: dns_zone_PerformRemoveVpcs + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneRemoveVpcsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformRemoveVpcsOutput' + summary: 移除VPC + tags: + - dns_zone + /dns_zones/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dns_zone_PerformSetClassMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dns_zone + /dns_zones/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dns_zone_PerformSetUserMetadata + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dns_zone + /dns_zones/{id}/status: + get: + description: 获取指定信息Status + operationId: dns_zone_GetDetailsStatus + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dns_zone_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - dns_zone + post: + description: 执行操作Status + operationId: dns_zone_PerformStatus + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformStatusOutput' + summary: 更新资源状态 + tags: + - dns_zone + /dns_zones/{id}/sync-recordsets: + post: + description: 执行操作SyncRecordsets + operationId: dns_zone_PerformSyncRecordsets + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneSyncRecordSetsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformSyncRecordsetsOutput' + summary: 同步解析列表到云上 + tags: + - dns_zone + /dns_zones/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: dns_zone_PerformSyncstatus + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneSyncStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformSyncstatusOutput' + summary: 同步状态 + tags: + - dns_zone + /dns_zones/{id}/uncache: + post: + description: 执行操作Uncache + operationId: dns_zone_PerformUncache + parameters: + - description: The Id or Name of dns_zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneUnacheInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformUncacheOutput' + summary: 删除云账号的云上资源 + tags: + - dns_zone + /dns_zones/capability: + get: + description: 获取指定资源类的信息Capability + operationId: dns_zone_GetPropertyCapability + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyCapabilityOutput' + summary: 获取指定资源类的信息Capability + tags: + - dns_zone + /dns_zones/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dns_zone_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dns_zone + /dns_zones/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: dns_zone_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - dns_zone + /dns_zones/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: dns_zone_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - dns_zone + /dns_zones/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dns_zone_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dns_zone: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dns_zone_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dns_zone + /dns_zones/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dns_zone_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dns_zone + /dns_zones/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dns_zone_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dns_zone + /dns_zones/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: dns_zone_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - dns_zone + /dns_zones/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dns_zone_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dns_zone + /dns_zones/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dns_zone_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dns_zone_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dns_zone + /domain_quotas/domains: + get: + description: 获取所有域的域配额 + operationId: models_ListDomainQuotas + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + responses: + "200": + $ref: '#/responses/models_ListDomainQuotasOutput' + summary: 获取所有域的域配额 + tags: + - domain_quota + /domain_quotas/domains/{domainId}: + get: + description: 获取指定域的配额 + operationId: models_GetDomainQuota + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 指定域的ID + in: path + name: domainId + required: true + type: string + x-go-name: DomainId + responses: + "200": + $ref: '#/responses/models_GetDomainQuotaOutput' + summary: 获取指定域的配额 + tags: + - domain_quota + post: + description: 设置域的域配额 + operationId: models_SetDomainQuotas + parameters: + - description: 指定域的ID + in: path + name: domainId + required: true + type: string + x-go-name: DomainId + - in: body + name: body + schema: + properties: + domain_quotas: + $ref: '#/definitions/SetDomainQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetDomainQuotasOutput' + summary: 设置域的域配额 + tags: + - domain_quota + /dynamicschedtags: + get: + description: 列表 + operationId: dynamicschedtag_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - description: filter by enabled status + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/dynamicschedtag_ListItemFilterOutput' + summary: 动态调度标签列表 + tags: + - dynamicschedtag + post: + description: 新建 + operationId: dynamicschedtag_ValidateCreateData + responses: + "200": + $ref: '#/responses/dynamicschedtag_ValidateCreateDataOutput' + summary: 新建 + tags: + - dynamicschedtag + /dynamicschedtags/{id}: + delete: + description: 删除 + operationId: dynamicschedtag_CustomizeDelete + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_CustomizeDeleteOutput' + summary: 删除 + tags: + - dynamicschedtag + get: + description: 获取详情 + operationId: dynamicschedtag_FetchCustomizeColumns + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - dynamicschedtag + put: + description: 更新 + operationId: dynamicschedtag_ValidateUpdateData + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_ValidateUpdateDataOutput' + summary: 更新 + tags: + - dynamicschedtag + /dynamicschedtags/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: dynamicschedtag_GetDetailsClassMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - dynamicschedtag + post: + description: 执行操作ClassMetadata + operationId: dynamicschedtag_PerformClassMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - dynamicschedtag + /dynamicschedtags/{id}/evaluate: + post: + description: 执行操作Evaluate + operationId: dynamicschedtag_PerformEvaluate + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformEvaluateOutput' + summary: 执行操作Evaluate + tags: + - dynamicschedtag + /dynamicschedtags/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: dynamicschedtag_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - dynamicschedtag + /dynamicschedtags/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: dynamicschedtag_PerformSetClassMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - dynamicschedtag + /dynamicschedtags/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: dynamicschedtag_PerformSetUserMetadata + parameters: + - description: The Id or Name of dynamicschedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - dynamicschedtag + /dynamicschedtags/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: dynamicschedtag_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - dynamicschedtag + /dynamicschedtags/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: dynamicschedtag_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/dynamicschedtag_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - dynamicschedtag + /dynamicschedtags/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: dynamicschedtag_GetPropertySplitable + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - dynamicschedtag + /dynamicschedtags/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: dynamicschedtag_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - dynamicschedtag + /dynamicschedtags/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: dynamicschedtag_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - dynamicschedtag + /dynamicschedtags/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: dynamicschedtag_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/dynamicschedtag_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - dynamicschedtag + /elastic_searches: + get: + description: 列表 + operationId: elastic_search_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/elastic_search_ListItemFilterOutput' + summary: ElasticSearch实例列表 + tags: + - elastic_search + post: + description: 新建 + operationId: elastic_search_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elastic_search: + $ref: '#/definitions/ElasticSearchCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_ValidateCreateDataOutput' + summary: 新建 + tags: + - elastic_search + /elastic_searches/{id}: + delete: + description: 删除 + operationId: elastic_search_CustomizeDelete + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_CustomizeDeleteOutput' + summary: 删除 + tags: + - elastic_search + get: + description: 获取详情 + operationId: elastic_search_FetchCustomizeColumns + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elastic_search + put: + description: 更新 + operationId: elastic_search_ValidateUpdateData + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elastic_search + /elastic_searches/{id}/access-info: + get: + description: 获取指定信息AccessInfo + operationId: elastic_search_GetDetailsAccessInfo + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsAccessInfoOutput' + summary: 获取指定信息AccessInfo + tags: + - elastic_search + /elastic_searches/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: elastic_search_PerformCancelDelete + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - elastic_search + /elastic_searches/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: elastic_search_PerformChangeOwner + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - elastic_search + /elastic_searches/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: elastic_search_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - elastic_search + /elastic_searches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elastic_search_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elastic_search + post: + description: 执行操作ClassMetadata + operationId: elastic_search_PerformClassMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elastic_search + /elastic_searches/{id}/freeze: + post: + description: 执行操作Freeze + operationId: elastic_search_PerformFreeze + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - elastic_search + /elastic_searches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elastic_search_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elastic_search + /elastic_searches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elastic_search_PerformSetClassMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elastic_search + /elastic_searches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elastic_search_PerformSetUserMetadata + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elastic_search + /elastic_searches/{id}/status: + get: + description: 获取指定信息Status + operationId: elastic_search_GetDetailsStatus + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elastic_search + post: + description: 执行操作Status + operationId: elastic_search_PerformStatus + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elastic_search + /elastic_searches/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: elastic_search_PerformSyncstatus + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elastic_search_PerformSyncstatusOutput' + summary: 同步ElasticSearch实例状态 + tags: + - elastic_search + /elastic_searches/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: elastic_search_PerformUnfreeze + parameters: + - description: The Id or Name of elastic_search + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - elastic_search + /elastic_searches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elastic_search_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elastic_search + /elastic_searches/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: elastic_search_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - elastic_search + /elastic_searches/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: elastic_search_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - elastic_search + /elastic_searches/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: elastic_search_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - elastic_search + /elastic_searches/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: elastic_search_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - elastic_search + /elastic_searches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elastic_search_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elastic_search: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elastic_search_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elastic_search + /elastic_searches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elastic_search_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elastic_search + /elastic_searches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elastic_search_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elastic_search + /elastic_searches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elastic_search_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elastic_search + /elastic_searches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elastic_search_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elastic_search + /elastic_searches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elastic_search_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elastic_search_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elastic_search + /elasticcache_accounts: + get: + description: 列表 + operationId: elasticcache_account_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: 账号类型 normal |admin + in: query + items: + type: string + name: account_type + type: array + x-go-name: AccountType + - description: 账号权限 read | write | repl（复制, 复制权限支持读写，且开放SYNC/PSYNC命令） + in: query + items: + type: string + name: account_privilege + type: array + x-go-name: AccountPrivilege + responses: + "200": + $ref: '#/responses/elasticcache_account_ListItemFilterOutput' + summary: 弹性缓存账号列表 + tags: + - elasticcache_account + post: + description: 新建 + operationId: elasticcache_account_ValidateCreateData + responses: + "200": + $ref: '#/responses/elasticcache_account_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_account + /elasticcache_accounts/{id}: + delete: + description: 删除 + operationId: elasticcache_account_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_account + get: + description: 获取详情 + operationId: elasticcache_account_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_account + put: + description: 更新 + operationId: elasticcache_account_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_account_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_account + post: + description: 执行操作ClassMetadata + operationId: elasticcache_account_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/login-info: + get: + description: 获取指定信息LoginInfo + operationId: elasticcache_account_GetDetailsLoginInfo + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsLoginInfoOutput' + summary: 获取指定信息LoginInfo + tags: + - elasticcache_account + /elasticcache_accounts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_account_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_account + /elasticcache_accounts/{id}/reset-password: + post: + description: 执行操作ResetPassword + operationId: elasticcache_account_PerformResetPassword + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformResetPasswordOutput' + summary: 执行操作ResetPassword + tags: + - elasticcache_account + /elasticcache_accounts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_account_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_account_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_account + /elasticcache_accounts/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_account_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_account_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_account + post: + description: 执行操作Status + operationId: elasticcache_account_PerformStatus + parameters: + - description: The Id or Name of elasticcache_account + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_account: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_account + /elasticcache_accounts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_account_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_account + /elasticcache_accounts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_account_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_account: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_account_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_account + /elasticcache_accounts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_account_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_account + /elasticcache_accounts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_account_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_account + /elasticcache_accounts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticcache_account_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticcache_account + /elasticcache_accounts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_account_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_account + /elasticcache_accounts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_account_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_account_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_account + /elasticcache_acls: + get: + description: 列表 + operationId: elasticcache_acl_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: Ip地址白名单列表 + in: query + name: ip_list + type: string + x-go-name: IpList + responses: + "200": + $ref: '#/responses/elasticcache_acl_ListItemFilterOutput' + summary: 弹性缓存ACL规则列表 + tags: + - elasticcache_acl + post: + description: 新建 + operationId: elasticcache_acl_ValidateCreateData + responses: + "200": + $ref: '#/responses/elasticcache_acl_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_acl + /elasticcache_acls/{id}: + delete: + description: 删除 + operationId: elasticcache_acl_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_acl + get: + description: 获取详情 + operationId: elasticcache_acl_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_acl + put: + description: 更新 + operationId: elasticcache_acl_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_acl_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_acl + post: + description: 执行操作ClassMetadata + operationId: elasticcache_acl_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_acl_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_acl + /elasticcache_acls/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_acl_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_acl_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_acl + /elasticcache_acls/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_acl_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_acl + post: + description: 执行操作Status + operationId: elasticcache_acl_PerformStatus + parameters: + - description: The Id or Name of elasticcache_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_acl + /elasticcache_acls/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_acl_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_acl + /elasticcache_acls/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_acl_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_acl_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_acl + /elasticcache_acls/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_acl_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_acl + /elasticcache_acls/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_acl_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_acl + /elasticcache_acls/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_acl_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_acl + /elasticcache_acls/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_acl_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_acl_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_acl + /elasticcache_backups: + get: + description: 列表 + operationId: elasticcache_backup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: 备份类型, 全量|增量额 + in: query + items: + type: string + name: backup_type + type: array + x-go-name: BackupType + - description: 备份模式，自动|手动 + in: query + items: + type: string + name: backup_mode + type: array + x-go-name: BackupMode + responses: + "200": + $ref: '#/responses/elasticcache_backup_ListItemFilterOutput' + summary: 弹性缓存备份列表 + tags: + - elasticcache_backup + post: + description: 新建 + operationId: elasticcache_backup_ValidateCreateData + responses: + "200": + $ref: '#/responses/elasticcache_backup_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_backup + /elasticcache_backups/{id}: + delete: + description: 删除 + operationId: elasticcache_backup_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_backup + get: + description: 获取详情 + operationId: elasticcache_backup_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_backup + put: + description: 更新 + operationId: elasticcache_backup_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_backup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_backup + post: + description: 执行操作ClassMetadata + operationId: elasticcache_backup_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_backup_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_backup + /elasticcache_backups/{id}/restore-instance: + post: + description: 执行操作RestoreInstance + operationId: elasticcache_backup_PerformRestoreInstance + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformRestoreInstanceOutput' + summary: 执行操作RestoreInstance + tags: + - elasticcache_backup + /elasticcache_backups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_backup_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_backup_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_backup + /elasticcache_backups/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_backup_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_backup + post: + description: 执行操作Status + operationId: elasticcache_backup_PerformStatus + parameters: + - description: The Id or Name of elasticcache_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_backup + /elasticcache_backups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_backup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_backup + /elasticcache_backups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_backup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_backup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_backup + /elasticcache_backups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_backup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_backup + /elasticcache_backups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_backup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_backup + /elasticcache_backups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticcache_backup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticcache_backup + /elasticcache_backups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_backup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_backup + /elasticcache_backups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_backup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_backup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_backup + /elasticcache_parameters: + get: + description: 列表 + operationId: elasticcache_parameter_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: 参数名称 + in: query + items: + type: string + name: key + type: array + x-go-name: Key + - description: 参数值 + in: query + items: + type: string + name: value + type: array + x-go-name: Value + responses: + "200": + $ref: '#/responses/elasticcache_parameter_ListItemFilterOutput' + summary: 列出弹性缓存参数 + tags: + - elasticcache_parameter + post: + description: 新建 + operationId: elasticcache_parameter_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticcache_parameter: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}: + delete: + description: 删除 + operationId: elasticcache_parameter_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_parameter + get: + description: 获取详情 + operationId: elasticcache_parameter_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_parameter + put: + description: 更新 + operationId: elasticcache_parameter_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_parameter_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_parameter + post: + description: 执行操作ClassMetadata + operationId: elasticcache_parameter_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_parameter_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_parameter_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_parameter_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_parameter + /elasticcache_parameters/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_parameter_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_parameter + post: + description: 执行操作Status + operationId: elasticcache_parameter_PerformStatus + parameters: + - description: The Id or Name of elasticcache_parameter + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_parameter + /elasticcache_parameters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_parameter_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_parameter + /elasticcache_parameters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_parameter_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_parameter_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_parameter + /elasticcache_parameters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_parameter_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_parameter + /elasticcache_parameters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_parameter_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_parameter + /elasticcache_parameters/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_parameter_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_parameter + /elasticcache_parameters/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_parameter_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_parameter_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_parameter + /elasticcache_skus: + get: + description: 列表 + operationId: elasticcache_sku_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: filter sku by memory size in MB + format: int64 + in: query + name: memory_size_mb + type: integer + x-go-name: MemorySizeMb + - in: query + items: + type: string + name: instance_spec + type: array + x-go-name: InstanceSpec + - in: query + items: + type: string + name: engine_arch + type: array + x-go-name: EngineArch + - in: query + items: + type: string + name: local_category + type: array + x-go-name: LocalCategory + - in: query + items: + type: string + name: prepaid_status + type: array + x-go-name: PrepaidStatus + - in: query + items: + type: string + name: postpaid_sStatus + type: array + x-go-name: PostpaidStatus + - description: 引擎 redis|memcached + in: query + items: + type: string + name: engine + type: array + x-go-name: Engine + - description: 引擎版本 3.0 + in: query + items: + type: string + name: engine_version + type: array + x-go-name: EngineVersion + - description: CPU 架构 x86|ARM + in: query + items: + type: string + name: cpu_arch + type: array + x-go-name: CpuArch + - description: 存储类型 DRAM|SCM + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - description: standrad|enhanced + in: query + items: + type: string + name: performance_type + type: array + x-go-name: PerformanceType + - description: single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | + readfive（5只读） + in: query + items: + type: string + name: node_type + type: array + x-go-name: NodeType + responses: + "200": + $ref: '#/responses/elasticcache_sku_ListItemFilterOutput' + summary: 弹性缓存套餐规格列表 + tags: + - elasticcache_sku + post: + description: 新建 + operationId: elasticcache_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticcache_sku: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache_sku + /elasticcache_skus/{id}: + delete: + description: 删除 + operationId: elasticcache_sku_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache_sku + get: + description: 获取详情 + operationId: elasticcache_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache_sku + put: + description: 更新 + operationId: elasticcache_sku_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache_sku + post: + description: 执行操作ClassMetadata + operationId: elasticcache_sku_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_sku_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache_sku + /elasticcache_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache_sku + /elasticcache_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_sku_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache_sku + post: + description: 执行操作Status + operationId: elasticcache_sku_PerformStatus + parameters: + - description: The Id or Name of elasticcache_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache_sku + /elasticcache_skus/capability: + get: + description: 获取指定资源类的信息Capability + operationId: elasticcache_sku_GetPropertyCapability + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyCapabilityOutput' + summary: 获取指定资源类的信息Capability + tags: + - elasticcache_sku + /elasticcache_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache_sku + /elasticcache_skus/instance-specs: + get: + description: 获取指定资源类的信息InstanceSpecs + operationId: elasticcache_sku_GetPropertyInstanceSpecs + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyInstanceSpecsOutput' + summary: 获取指定资源类的信息InstanceSpecs + tags: + - elasticcache_sku + /elasticcache_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache_sku + /elasticcache_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache_sku + /elasticcache_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_sku_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache_sku + /elasticcache_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticcache_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticcache_sku + /elasticcache_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: elasticcache_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - elasticcache_sku + /elasticcache_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: elasticcache_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - elasticcache_sku + /elasticcache_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache_sku + /elasticcache_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache_sku + /elasticcaches: + get: + description: 列表 + operationId: elasticcache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: 实例规格 + example: redis.master.micro.default + in: query + items: + type: string + name: instance_type + type: array + x-go-name: InstanceType + - description: 对应Sku + in: query + items: + type: string + name: local_category + type: array + x-go-name: LocalCategory + - description: |- + 类型 + single（单副本） | double（双副本) | readone (单可读) | readthree （3可读） | readfive（5只读） + in: query + items: + type: string + name: node_type + type: array + x-go-name: NodeType + - description: |- + 后端存储引擎 + Redis | Memcache + example: redis + in: query + items: + type: string + name: engine + type: array + x-go-name: Engine + - description: 后端存储引擎版本 + example: "4.0" + in: query + items: + type: string + name: engine_version + type: array + x-go-name: EngineVersion + - description: 网络类型, CLASSIC（经典网络） VPC（专有网络） + example: CLASSIC + in: query + items: + type: string + name: network_type + type: array + x-go-name: NetworkType + - description: 内网DNS + in: query + items: + type: string + name: private_dns + type: array + x-go-name: PrivateDNS + - description: 内网IP地址 + in: query + items: + type: string + name: private_ip_addr + type: array + x-go-name: PrivateIpAddr + - description: 内网访问端口 + in: query + items: + format: int64 + type: integer + name: private_connect_port + type: array + x-go-name: PrivateConnectPort + - description: 公网DNS + in: query + items: + type: string + name: public_dns + type: array + x-go-name: PublicDNS + - description: 公网IP地址 + in: query + items: + type: string + name: public_ip_addr + type: array + x-go-name: PublicIpAddr + - description: 外网访问端口 + in: query + items: + format: int64 + type: integer + name: public_connect_port + type: array + x-go-name: PublicConnectPort + - description: 访问密码？ on （开启密码）|off （免密码访问） + in: query + items: + type: string + name: auth_mode + type: array + x-go-name: AuthMode + responses: + "200": + $ref: '#/responses/elasticcache_ListItemFilterOutput' + summary: 列出弹性缓存（redis等） + tags: + - elasticcache + post: + description: 新建 + operationId: elasticcache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticcache: + $ref: '#/definitions/ElasticcacheCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcache + /elasticcaches/{id}: + delete: + description: 删除 + operationId: elasticcache_CustomizeDelete + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcache + get: + description: 获取详情 + operationId: elasticcache_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcache + put: + description: 更新 + operationId: elasticcache_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcache + /elasticcaches/{id}/add-secgroup: + post: + description: 执行操作AddSecgroup + operationId: elasticcache_PerformAddSecgroup + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheSecgroupsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformAddSecgroupOutput' + summary: 执行操作AddSecgroup + tags: + - elasticcache + /elasticcaches/{id}/allocate-public-connection: + post: + description: 执行操作AllocatePublicConnection + operationId: elasticcache_PerformAllocatePublicConnection + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformAllocatePublicConnectionOutput' + summary: 执行操作AllocatePublicConnection + tags: + - elasticcache + /elasticcaches/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: elasticcache_PerformCancelDelete + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - elasticcache + /elasticcaches/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: elasticcache_PerformCancelExpire + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - elasticcache + /elasticcaches/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: elasticcache_PerformChangeOwner + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - elasticcache + /elasticcaches/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: elasticcache_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - elasticcache + /elasticcaches/{id}/change-spec: + post: + description: 执行操作ChangeSpec + operationId: elasticcache_PerformChangeSpec + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformChangeSpecOutput' + summary: 执行操作ChangeSpec + tags: + - elasticcache + /elasticcaches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticcache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticcache + post: + description: 执行操作ClassMetadata + operationId: elasticcache_PerformClassMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticcache + /elasticcaches/{id}/flush-instance: + post: + description: 执行操作FlushInstance + operationId: elasticcache_PerformFlushInstance + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformFlushInstanceOutput' + summary: 执行操作FlushInstance + tags: + - elasticcache + /elasticcaches/{id}/freeze: + post: + description: 执行操作Freeze + operationId: elasticcache_PerformFreeze + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - elasticcache + /elasticcaches/{id}/login-info: + get: + description: 获取指定信息LoginInfo + operationId: elasticcache_GetDetailsLoginInfo + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsLoginInfoOutput' + summary: 获取指定信息LoginInfo + tags: + - elasticcache + /elasticcaches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticcache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticcache + /elasticcaches/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: elasticcache_PerformPostpaidExpire + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - elasticcache + /elasticcaches/{id}/release-public-connection: + post: + description: 执行操作ReleasePublicConnection + operationId: elasticcache_PerformReleasePublicConnection + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformReleasePublicConnectionOutput' + summary: 执行操作ReleasePublicConnection + tags: + - elasticcache + /elasticcaches/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: elasticcache_PerformRemoteUpdate + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - elasticcache + /elasticcaches/{id}/renew: + post: + description: 执行操作Renew + operationId: elasticcache_PerformRenew + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformRenewOutput' + summary: 执行操作Renew + tags: + - elasticcache + /elasticcaches/{id}/reset-password: + post: + description: 执行操作ResetPassword + operationId: elasticcache_PerformResetPassword + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformResetPasswordOutput' + summary: 执行操作ResetPassword + tags: + - elasticcache + /elasticcaches/{id}/restart: + post: + description: 执行操作Restart + operationId: elasticcache_PerformRestart + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformRestartOutput' + summary: 执行操作Restart + tags: + - elasticcache + /elasticcaches/{id}/revoke-secgroup: + post: + description: 执行操作RevokeSecgroup + operationId: elasticcache_PerformRevokeSecgroup + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheSecgroupsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformRevokeSecgroupOutput' + summary: 执行操作RevokeSecgroup + tags: + - elasticcache + /elasticcaches/{id}/set-auto-renew: + post: + description: |- + 要求实例状态为running + 要求实例计费类型为包年包月(预付费) + operationId: elasticcache_PerformSetAutoRenew + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/GuestAutoRenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetAutoRenewOutput' + summary: 设置自动续费 + tags: + - elasticcache + /elasticcaches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticcache_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticcache + /elasticcaches/{id}/set-maintain-time: + post: + description: 执行操作SetMaintainTime + operationId: elasticcache_PerformSetMaintainTime + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetMaintainTimeOutput' + summary: 执行操作SetMaintainTime + tags: + - elasticcache + /elasticcaches/{id}/set-secgroup: + post: + description: 执行操作SetSecgroup + operationId: elasticcache_PerformSetSecgroup + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheSecgroupsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetSecgroupOutput' + summary: 执行操作SetSecgroup + tags: + - elasticcache + /elasticcaches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticcache_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticcache + /elasticcaches/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticcache_GetDetailsStatus + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticcache + post: + description: 执行操作Status + operationId: elasticcache_PerformStatus + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticcache + /elasticcaches/{id}/sync: + post: + description: 执行操作Sync + operationId: elasticcache_PerformSync + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformSyncOutput' + summary: 执行操作Sync + tags: + - elasticcache + /elasticcaches/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: elasticcache_PerformSyncstatus + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformSyncstatusOutput' + summary: 同步弹性缓存状态 + tags: + - elasticcache + /elasticcaches/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: elasticcache_PerformUnfreeze + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - elasticcache + /elasticcaches/{id}/update-auth-mode: + post: + description: 执行操作UpdateAuthMode + operationId: elasticcache_PerformUpdateAuthMode + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformUpdateAuthModeOutput' + summary: 执行操作UpdateAuthMode + tags: + - elasticcache + /elasticcaches/{id}/update-backup-policy: + post: + description: 执行操作UpdateBackupPolicy + operationId: elasticcache_PerformUpdateBackupPolicy + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformUpdateBackupPolicyOutput' + summary: 执行操作UpdateBackupPolicy + tags: + - elasticcache + /elasticcaches/{id}/update-instance-parameters: + post: + description: 执行操作UpdateInstanceParameters + operationId: elasticcache_PerformUpdateInstanceParameters + parameters: + - description: The Id or Name of elasticcache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcache_PerformUpdateInstanceParametersOutput' + summary: 执行操作UpdateInstanceParameters + tags: + - elasticcache + /elasticcaches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcache + /elasticcaches/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: elasticcache_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - elasticcache + /elasticcaches/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: elasticcache_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - elasticcache + /elasticcaches/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: elasticcache_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - elasticcache + /elasticcaches/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: elasticcache_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - elasticcache + /elasticcaches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcache + /elasticcaches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcache + /elasticcaches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcache + /elasticcaches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticcache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticcache + /elasticcaches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticcache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticcache + /elasticcaches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticcache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticcache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticcache + /elasticcachesecgroups: + get: + description: 列表 + operationId: elasticcachesecgroup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 以弹性缓存实例名称排序 + in: query + name: order_by_elasticcache + type: string + x-go-name: OrderByElasticcache + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_ListItemFilterOutput' + summary: 列表 + tags: + - elasticcachesecgroup + post: + description: 新建 + operationId: elasticcachesecgroup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticcachesecgroup: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticcachesecgroup + /elasticcachesecgroups/{id}: + delete: + description: 删除 + operationId: elasticcachesecgroup_CustomizeDelete + parameters: + - description: The Id or Name of elasticcachesecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticcachesecgroup + get: + description: 获取详情 + operationId: elasticcachesecgroup_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticcachesecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticcachesecgroup + put: + description: 更新 + operationId: elasticcachesecgroup_ValidateUpdateData + parameters: + - description: The Id or Name of elasticcachesecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcacheJointBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticcachesecgroup + /elasticcachesecgroups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticcachesecgroup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticcachesecgroup + /elasticcachesecgroups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticcachesecgroup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticcachesecgroup + /elasticcachesecgroups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticcachesecgroup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticcachesecgroup + /elasticcachesecgroups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticcachesecgroup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elasticcachesecgroup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticcachesecgroup + /elasticips: + get: + description: 列表 + operationId: elasticip_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: |- + filter usable eip for given associate type + enmu: server, natgateway + in: query + name: usable_eip_for_associate_type + type: string + x-go-name: UsableEipForAssociateType + - description: filter usable eip for given associate id + in: query + name: usable_eip_for_associate_id + type: string + x-go-name: UsableEipForAssociateId + - description: |- + 标识弹性或非弹性 + Mode | 说明 | + ------------|------------| + public_ip | 公网IP | + elastic_ip | 弹性公公网网IP | + example: elastic_ip + in: query + name: mode + type: string + x-go-name: Mode + - description: IP地址 + in: query + name: ip_addr + type: string + x-go-name: IpAddr + - description: 绑定资源类型 + in: query + name: associate_type + type: string + x-go-name: AssociateType + - description: 绑定资源Id + in: query + name: associate_id + type: string + x-go-name: AssociateId + - description: '计费类型: 流量、带宽' + example: bandwidth + in: query + items: + type: string + name: charge_type + type: array + x-go-name: ChargeType + - description: 目前只有华为云此字段是必需填写的 + in: query + items: + type: string + name: bgp_type + type: array + x-go-name: BgpType + - description: 是否跟随主机删除而自动释放 + in: query + name: auto_dellocate + type: boolean + x-go-name: AutoDellocate + - description: 按ip地址排序 + in: query + name: order_by_ip + pattern: asc|desc + type: string + x-go-name: OrderByIp + responses: + "200": + $ref: '#/responses/elasticip_ListItemFilterOutput' + summary: 弹性公网IP列表 + tags: + - elasticip + post: + description: 新建 + operationId: elasticip_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + elasticip: + $ref: '#/definitions/SElasticipCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_ValidateCreateDataOutput' + summary: 新建 + tags: + - elasticip + /elasticips/{id}: + delete: + description: 删除 + operationId: elasticip_CustomizeDelete + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_CustomizeDeleteOutput' + summary: 删除 + tags: + - elasticip + get: + description: 获取详情 + operationId: elasticip_FetchCustomizeColumns + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - elasticip + put: + description: 更新 + operationId: elasticip_ValidateUpdateData + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_ValidateUpdateDataOutput' + summary: 更新 + tags: + - elasticip + /elasticips/{id}/associate: + post: + description: 执行操作Associate + operationId: elasticip_PerformAssociate + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipAssociateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformAssociateOutput' + summary: 执行操作Associate + tags: + - elasticip + /elasticips/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: elasticip_PerformCancelDelete + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - elasticip + /elasticips/{id}/change-bandwidth: + post: + description: 执行操作ChangeBandwidth + operationId: elasticip_PerformChangeBandwidth + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_PerformChangeBandwidthOutput' + summary: 执行操作ChangeBandwidth + tags: + - elasticip + /elasticips/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: elasticip_PerformChangeOwner + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - elasticip + /elasticips/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: elasticip_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - elasticip + /elasticips/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: elasticip_GetDetailsClassMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - elasticip + post: + description: 执行操作ClassMetadata + operationId: elasticip_PerformClassMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - elasticip + /elasticips/{id}/dissociate: + post: + description: 执行操作Dissociate + operationId: elasticip_PerformDissociate + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticDissociateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformDissociateOutput' + summary: 执行操作Dissociate + tags: + - elasticip + /elasticips/{id}/freeze: + post: + description: 执行操作Freeze + operationId: elasticip_PerformFreeze + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - elasticip + /elasticips/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: elasticip_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - elasticip + /elasticips/{id}/purge: + post: + description: 执行操作Purge + operationId: elasticip_PerformPurge + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - elasticip + /elasticips/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: elasticip_PerformSetClassMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - elasticip + /elasticips/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: elasticip_PerformSetUserMetadata + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - elasticip + /elasticips/{id}/status: + get: + description: 获取指定信息Status + operationId: elasticip_GetDetailsStatus + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - elasticip + post: + description: 执行操作Status + operationId: elasticip_PerformStatus + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformStatusOutput' + summary: 更新资源状态 + tags: + - elasticip + /elasticips/{id}/sync: + post: + description: 执行操作Sync + operationId: elasticip_PerformSync + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/elasticip_PerformSyncOutput' + summary: 执行操作Sync + tags: + - elasticip + /elasticips/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: elasticip_PerformSyncstatus + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformSyncstatusOutput' + summary: 同步弹性公网IP状态 + tags: + - elasticip + /elasticips/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: elasticip_PerformUnfreeze + parameters: + - description: The Id or Name of elasticip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - elasticip + /elasticips/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: elasticip_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - elasticip + /elasticips/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: elasticip_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - elasticip + /elasticips/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: elasticip_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - elasticip + /elasticips/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: elasticip_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - elasticip + /elasticips/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: elasticip_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - elasticip + /elasticips/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: elasticip_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + elasticip: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/elasticip_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - elasticip + /elasticips/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: elasticip_GetPropertySplitable + responses: + "200": + $ref: '#/responses/elasticip_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - elasticip + /elasticips/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: elasticip_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/elasticip_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - elasticip + /elasticips/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: elasticip_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - elasticip + /elasticips/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: elasticip_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - elasticip + /elasticips/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: elasticip_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/elasticip_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - elasticip + /external_projects: + get: + description: 列表 + operationId: external_project_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/external_project_ListItemFilterOutput' + summary: 云平台导入项目列表 + tags: + - external_project + post: + description: 新建 + operationId: external_project_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + external_project: + $ref: '#/definitions/ExternalProjectCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_ValidateCreateDataOutput' + summary: 新建 + tags: + - external_project + /external_projects/{id}: + delete: + description: 删除 + operationId: external_project_CustomizeDelete + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_CustomizeDeleteOutput' + summary: 删除 + tags: + - external_project + get: + description: 获取详情 + operationId: external_project_FetchCustomizeColumns + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - external_project + put: + description: 更新 + operationId: external_project_ValidateUpdateData + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_ValidateUpdateDataOutput' + summary: 更新 + tags: + - external_project + /external_projects/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: external_project_PerformCancelDelete + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - external_project + /external_projects/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: external_project_PerformChangeOwner + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - external_project + /external_projects/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: external_project_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - external_project + /external_projects/{id}/change-project: + post: + description: 执行操作ChangeProject + operationId: external_project_PerformChangeProject + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectChangeProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformChangeProjectOutput' + summary: 切换本地项目 + tags: + - external_project + /external_projects/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: external_project_GetDetailsClassMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - external_project + post: + description: 执行操作ClassMetadata + operationId: external_project_PerformClassMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - external_project + /external_projects/{id}/freeze: + post: + description: 执行操作Freeze + operationId: external_project_PerformFreeze + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - external_project + /external_projects/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: external_project_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - external_project + /external_projects/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: external_project_PerformSetClassMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - external_project + /external_projects/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: external_project_PerformSetUserMetadata + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - external_project + /external_projects/{id}/status: + get: + description: 获取指定信息Status + operationId: external_project_GetDetailsStatus + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/external_project_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - external_project + post: + description: 执行操作Status + operationId: external_project_PerformStatus + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformStatusOutput' + summary: 更新资源状态 + tags: + - external_project + /external_projects/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: external_project_PerformUnfreeze + parameters: + - description: The Id or Name of external_project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - external_project + /external_projects/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: external_project_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/external_project_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - external_project + /external_projects/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: external_project_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/external_project_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - external_project + /external_projects/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: external_project_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/external_project_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - external_project + /external_projects/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: external_project_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/external_project_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - external_project + /external_projects/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: external_project_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/external_project_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - external_project + /external_projects/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: external_project_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + external_project: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/external_project_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - external_project + /external_projects/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: external_project_GetPropertySplitable + responses: + "200": + $ref: '#/responses/external_project_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - external_project + /external_projects/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: external_project_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/external_project_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - external_project + /external_projects/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: external_project_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/external_project_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - external_project + /external_projects/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: external_project_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/external_project_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - external_project + /external_projects/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: external_project_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/external_project_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - external_project + /file_systems: + get: + description: 列表 + operationId: file_system_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/file_system_ListItemFilterOutput' + summary: 列表 + tags: + - file_system + post: + description: 新建 + operationId: file_system_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + file_system: + $ref: '#/definitions/FileSystemCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_ValidateCreateDataOutput' + summary: 新建 + tags: + - file_system + /file_systems/{id}: + delete: + description: 删除 + operationId: file_system_CustomizeDelete + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_CustomizeDeleteOutput' + summary: 删除 + tags: + - file_system + get: + description: 获取详情 + operationId: file_system_FetchCustomizeColumns + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - file_system + put: + description: 更新 + operationId: file_system_ValidateUpdateData + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_ValidateUpdateDataOutput' + summary: 更新 + tags: + - file_system + /file_systems/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: file_system_PerformChangeOwner + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - file_system + /file_systems/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: file_system_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - file_system + /file_systems/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: file_system_GetDetailsClassMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - file_system + post: + description: 执行操作ClassMetadata + operationId: file_system_PerformClassMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - file_system + /file_systems/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: file_system_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - file_system + /file_systems/{id}/private: + post: + description: 执行操作Private + operationId: file_system_PerformPrivate + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformPrivateOutput' + summary: 执行操作Private + tags: + - file_system + /file_systems/{id}/public: + post: + description: 执行操作Public + operationId: file_system_PerformPublic + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformPublicOutput' + summary: 执行操作Public + tags: + - file_system + /file_systems/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: file_system_PerformRemoteUpdate + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - file_system + /file_systems/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: file_system_PerformSetClassMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - file_system + /file_systems/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: file_system_PerformSetUserMetadata + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - file_system + /file_systems/{id}/status: + get: + description: 获取指定信息Status + operationId: file_system_GetDetailsStatus + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/file_system_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - file_system + post: + description: 执行操作Status + operationId: file_system_PerformStatus + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformStatusOutput' + summary: 更新资源状态 + tags: + - file_system + /file_systems/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: file_system_PerformSyncstatus + parameters: + - description: The Id or Name of file_system + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformSyncstatusOutput' + summary: 同步NAS状态 + tags: + - file_system + /file_systems/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: file_system_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/file_system_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - file_system + /file_systems/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: file_system_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/file_system_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - file_system + /file_systems/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: file_system_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/file_system_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - file_system + /file_systems/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: file_system_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + file_system: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/file_system_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - file_system + /file_systems/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: file_system_GetPropertySplitable + responses: + "200": + $ref: '#/responses/file_system_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - file_system + /file_systems/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: file_system_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/file_system_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - file_system + /file_systems/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: file_system_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/file_system_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - file_system + /file_systems/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: file_system_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/file_system_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - file_system + /file_systems/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: file_system_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/file_system_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - file_system + /global_vpcs: + get: + description: 列表 + operationId: global_vpc_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以关联的vpc数量排序 + in: query + name: order_by_vpc_count + pattern: asc|desc + type: string + x-go-name: OrderByVpcCount + responses: + "200": + $ref: '#/responses/global_vpc_ListItemFilterOutput' + summary: 全局VPC列表 + tags: + - global_vpc + post: + description: 新建 + operationId: global_vpc_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + global_vpc: + $ref: '#/definitions/GlobalVpcCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_ValidateCreateDataOutput' + summary: 新建 + tags: + - global_vpc + /global_vpcs/{id}: + delete: + description: 删除 + operationId: global_vpc_CustomizeDelete + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_CustomizeDeleteOutput' + summary: 删除 + tags: + - global_vpc + get: + description: 获取详情 + operationId: global_vpc_FetchCustomizeColumns + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - global_vpc + put: + description: 更新 + operationId: global_vpc_ValidateUpdateData + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalvpcUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_ValidateUpdateDataOutput' + summary: 更新 + tags: + - global_vpc + /global_vpcs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: global_vpc_PerformChangeOwner + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - global_vpc + /global_vpcs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: global_vpc_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - global_vpc + /global_vpcs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: global_vpc_GetDetailsClassMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - global_vpc + post: + description: 执行操作ClassMetadata + operationId: global_vpc_PerformClassMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - global_vpc + /global_vpcs/{id}/disable: + post: + description: 执行操作Disable + operationId: global_vpc_PerformDisable + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformDisableOutput' + summary: 禁用资源 + tags: + - global_vpc + /global_vpcs/{id}/enable: + post: + description: 执行操作Enable + operationId: global_vpc_PerformEnable + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformEnableOutput' + summary: 启用资源 + tags: + - global_vpc + /global_vpcs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: global_vpc_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - global_vpc + /global_vpcs/{id}/private: + post: + description: 执行操作Private + operationId: global_vpc_PerformPrivate + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformPrivateOutput' + summary: 执行操作Private + tags: + - global_vpc + /global_vpcs/{id}/public: + post: + description: 执行操作Public + operationId: global_vpc_PerformPublic + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformPublicOutput' + summary: 执行操作Public + tags: + - global_vpc + /global_vpcs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: global_vpc_PerformSetClassMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - global_vpc + /global_vpcs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: global_vpc_PerformSetUserMetadata + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - global_vpc + /global_vpcs/{id}/status: + get: + description: 获取指定信息Status + operationId: global_vpc_GetDetailsStatus + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/global_vpc_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - global_vpc + post: + description: 执行操作Status + operationId: global_vpc_PerformStatus + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformStatusOutput' + summary: 更新资源状态 + tags: + - global_vpc + /global_vpcs/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: global_vpc_PerformSyncstatus + parameters: + - description: The Id or Name of global_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/SyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformSyncstatusOutput' + summary: 同步全局VPC状态 + tags: + - global_vpc + /global_vpcs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: global_vpc_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - global_vpc + /global_vpcs/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: global_vpc_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - global_vpc + /global_vpcs/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: global_vpc_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - global_vpc + /global_vpcs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: global_vpc_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + global_vpc: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/global_vpc_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - global_vpc + /global_vpcs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: global_vpc_GetPropertySplitable + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - global_vpc + /global_vpcs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: global_vpc_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - global_vpc + /global_vpcs/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: global_vpc_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - global_vpc + /global_vpcs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: global_vpc_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - global_vpc + /global_vpcs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: global_vpc_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/global_vpc_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - global_vpc + /groupguests: + get: + description: 列表 + operationId: groupguest_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 实例组（ID或Name） + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 按组名排序 + in: query + name: order_by_group + type: string + x-go-name: OrderByGroup + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 标签 + in: query + items: + type: string + name: tag + type: array + x-go-name: Tag + responses: + "200": + $ref: '#/responses/groupguest_ListItemFilterOutput' + summary: 列表 + tags: + - groupguest + post: + description: 新建 + operationId: groupguest_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + groupguest: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupguest_ValidateCreateDataOutput' + summary: 新建 + tags: + - groupguest + /groupguests/{id}: + delete: + description: 删除 + operationId: groupguest_CustomizeDelete + parameters: + - description: The Id or Name of groupguest + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/groupguest_CustomizeDeleteOutput' + summary: 删除 + tags: + - groupguest + get: + description: 获取详情 + operationId: groupguest_FetchCustomizeColumns + parameters: + - description: The Id or Name of groupguest + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/groupguest_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - groupguest + put: + description: 更新 + operationId: groupguest_ValidateUpdateData + parameters: + - description: The Id or Name of groupguest + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + groupguest: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupguest_ValidateUpdateDataOutput' + summary: 更新 + tags: + - groupguest + /groupguests/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: groupguest_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/groupguest_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - groupguest + /groupguests/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: groupguest_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + groupguest: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupguest_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - groupguest + /groupguests/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: groupguest_GetPropertySplitable + responses: + "200": + $ref: '#/responses/groupguest_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - groupguest + /groupguests/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: groupguest_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/groupguest_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - groupguest + /groupnetworks: + get: + description: 列表 + operationId: groupnetwork_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 实例组（ID或Name） + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 按组名排序 + in: query + name: order_by_group + type: string + x-go-name: OrderByGroup + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: IP地址 + in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + responses: + "200": + $ref: '#/responses/groupnetwork_ListItemFilterOutput' + summary: 列表 + tags: + - groupnetwork + post: + description: 新建 + operationId: groupnetwork_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + groupnetwork: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupnetwork_ValidateCreateDataOutput' + summary: 新建 + tags: + - groupnetwork + /groupnetworks/{id}: + delete: + description: 删除 + operationId: groupnetwork_CustomizeDelete + parameters: + - description: The Id or Name of groupnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/groupnetwork_CustomizeDeleteOutput' + summary: 删除 + tags: + - groupnetwork + get: + description: 获取详情 + operationId: groupnetwork_FetchCustomizeColumns + parameters: + - description: The Id or Name of groupnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/groupnetwork_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - groupnetwork + put: + description: 更新 + operationId: groupnetwork_ValidateUpdateData + parameters: + - description: The Id or Name of groupnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + groupnetwork: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupnetwork_ValidateUpdateDataOutput' + summary: 更新 + tags: + - groupnetwork + /groupnetworks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: groupnetwork_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/groupnetwork_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - groupnetwork + /groupnetworks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: groupnetwork_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + groupnetwork: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/groupnetwork_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - groupnetwork + /groupnetworks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: groupnetwork_GetPropertySplitable + responses: + "200": + $ref: '#/responses/groupnetwork_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - groupnetwork + /groupnetworks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: groupnetwork_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/groupnetwork_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - groupnetwork + /groups: + get: + description: 列表 + operationId: group_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 以service_type过滤列表结果 + in: query + name: service_type + type: string + x-go-name: ServiceType + - description: 以parent_id过滤列表结果 + in: query + name: parent_id + type: string + x-go-name: ParentId + - description: 调度策略 + in: query + name: sched_strategy + type: string + x-go-name: SchedStrategy + - description: 按ip地址排序 + in: query + name: order_by_vips + pattern: asc|desc + type: string + x-go-name: OrderByVips + - description: 按关联的虚拟机数量排序 + in: query + name: order_by_guest_count + pattern: asc|desc + type: string + x-go-name: OrderByGuestCount + responses: + "200": + $ref: '#/responses/group_ListItemFilterOutput' + summary: 主机组列表 + tags: + - group + post: + description: 新建 + operationId: group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + group: + $ref: '#/definitions/VirtualResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_ValidateCreateDataOutput' + summary: 新建 + tags: + - group + /groups/{id}: + delete: + description: 删除 + operationId: group_CustomizeDelete + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_CustomizeDeleteOutput' + summary: 删除 + tags: + - group + get: + description: 获取详情 + operationId: group_FetchCustomizeColumns + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - group + put: + description: 更新 + operationId: group_ValidateUpdateData + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - group + /groups/{id}/associate-eip: + post: + description: 执行操作AssociateEip + operationId: group_PerformAssociateEip + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/ServerAssociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformAssociateEipOutput' + summary: 执行操作AssociateEip + tags: + - group + /groups/{id}/attachnetwork: + post: + description: 执行操作Attachnetwork + operationId: group_PerformAttachnetwork + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/GroupAttachNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformAttachnetworkOutput' + summary: 执行操作Attachnetwork + tags: + - group + /groups/{id}/bind-guests: + post: + description: 执行操作BindGuests + operationId: group_PerformBindGuests + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_PerformBindGuestsOutput' + summary: 执行操作BindGuests + tags: + - group + /groups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: group_PerformCancelDelete + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - group + /groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: group_PerformChangeOwner + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - group + /groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - group + /groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - group + post: + description: 执行操作ClassMetadata + operationId: group_PerformClassMetadata + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - group + /groups/{id}/create-eip: + post: + description: 执行操作CreateEip + operationId: group_PerformCreateEip + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/ServerCreateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformCreateEipOutput' + summary: 执行操作CreateEip + tags: + - group + /groups/{id}/detachnetwork: + post: + description: 执行操作Detachnetwork + operationId: group_PerformDetachnetwork + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/GroupDetachNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformDetachnetworkOutput' + summary: 执行操作Detachnetwork + tags: + - group + /groups/{id}/disable: + post: + description: 执行操作Disable + operationId: group_PerformDisable + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformDisableOutput' + summary: 执行操作Disable + tags: + - group + /groups/{id}/dissociate-eip: + post: + description: 执行操作DissociateEip + operationId: group_PerformDissociateEip + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/ServerDissociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformDissociateEipOutput' + summary: 执行操作DissociateEip + tags: + - group + /groups/{id}/enable: + post: + description: 执行操作Enable + operationId: group_PerformEnable + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformEnableOutput' + summary: 执行操作Enable + tags: + - group + /groups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: group_PerformFreeze + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - group + /groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: group_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - group + /groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: group_PerformSetClassMetadata + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - group + /groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: group_PerformSetUserMetadata + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - group + /groups/{id}/status: + get: + description: 获取指定信息Status + operationId: group_GetDetailsStatus + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - group + post: + description: 执行操作Status + operationId: group_PerformStatus + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - group + /groups/{id}/unbind-guests: + post: + description: 执行操作UnbindGuests + operationId: group_PerformUnbindGuests + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_PerformUnbindGuestsOutput' + summary: 执行操作UnbindGuests + tags: + - group + /groups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: group_PerformUnfreeze + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - group + /groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - group + /groups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: group_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/group_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - group + /groups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: group_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/group_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - group + /groups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: group_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/group_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - group + /groups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: group_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/group_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - group + /groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - group + /groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - group + /groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: group_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - group + /groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - group + /groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - group + /groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - group + /guest_templates: + get: + description: 列表 + operationId: guest_template_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: billing_type + type: string + x-go-name: BillingType + - in: query + name: brand + type: string + x-go-name: Brand + responses: + "200": + $ref: '#/responses/guest_template_ListItemFilterOutput' + summary: 主机模板列表 + tags: + - guest_template + post: + description: 新建 + operationId: guest_template_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guest_template: + $ref: '#/definitions/GuestTemplateCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_ValidateCreateDataOutput' + summary: 新建 + tags: + - guest_template + /guest_templates/{id}: + delete: + description: 删除 + operationId: guest_template_CustomizeDelete + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_CustomizeDeleteOutput' + summary: 删除 + tags: + - guest_template + get: + description: 获取详情 + operationId: guest_template_FetchCustomizeColumns + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guest_template + put: + description: 更新 + operationId: guest_template_ValidateUpdateData + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guest_template + /guest_templates/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: guest_template_PerformCancelDelete + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - guest_template + /guest_templates/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: guest_template_PerformChangeOwner + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - guest_template + /guest_templates/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: guest_template_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - guest_template + /guest_templates/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: guest_template_GetDetailsClassMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - guest_template + post: + description: 执行操作ClassMetadata + operationId: guest_template_PerformClassMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - guest_template + /guest_templates/{id}/freeze: + post: + description: 执行操作Freeze + operationId: guest_template_PerformFreeze + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - guest_template + /guest_templates/{id}/inspect: + post: + description: 执行操作Inspect + operationId: guest_template_PerformInspect + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_PerformInspectOutput' + summary: 执行操作Inspect + tags: + - guest_template + /guest_templates/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: guest_template_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - guest_template + /guest_templates/{id}/private: + post: + description: 执行操作Private + operationId: guest_template_PerformPrivate + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformPrivateOutput' + summary: 执行操作Private + tags: + - guest_template + /guest_templates/{id}/public: + post: + description: 执行操作Public + operationId: guest_template_PerformPublic + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformPublicOutput' + summary: 执行操作Public + tags: + - guest_template + /guest_templates/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: guest_template_PerformSetClassMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - guest_template + /guest_templates/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: guest_template_PerformSetUserMetadata + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - guest_template + /guest_templates/{id}/status: + get: + description: 获取指定信息Status + operationId: guest_template_GetDetailsStatus + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_template_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - guest_template + post: + description: 执行操作Status + operationId: guest_template_PerformStatus + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformStatusOutput' + summary: 更新资源状态 + tags: + - guest_template + /guest_templates/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: guest_template_PerformUnfreeze + parameters: + - description: The Id or Name of guest_template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - guest_template + /guest_templates/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guest_template_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guest_template + /guest_templates/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: guest_template_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - guest_template + /guest_templates/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: guest_template_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - guest_template + /guest_templates/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: guest_template_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - guest_template + /guest_templates/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: guest_template_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - guest_template + /guest_templates/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guest_template_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guest_template: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_template_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guest_template + /guest_templates/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guest_template_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guest_template_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guest_template + /guest_templates/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guest_template_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/guest_template_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guest_template + /guest_templates/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: guest_template_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - guest_template + /guest_templates/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: guest_template_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - guest_template + /guest_templates/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: guest_template_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/guest_template_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - guest_template + /guestdisks: + get: + description: 列表 + operationId: guestdisk_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 虚拟磁盘（ID或Name） + in: query + name: disk_id + type: string + x-go-name: DiskId + - description: 以磁盘名称排序 + in: query + name: order_by_disk + pattern: asc|desc + type: string + x-go-name: OrderByDisk + - in: query + items: + type: string + name: driver + type: array + x-go-name: Driver + - in: query + items: + type: string + name: cache_mode + type: array + x-go-name: CacheMode + - in: query + items: + type: string + name: aio_mode + type: array + x-go-name: AioMode + responses: + "200": + $ref: '#/responses/guestdisk_ListItemFilterOutput' + summary: 列表 + tags: + - guestdisk + post: + description: 新建 + operationId: guestdisk_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guestdisk: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestdisk_ValidateCreateDataOutput' + summary: 新建 + tags: + - guestdisk + /guestdisks/{id}: + delete: + description: 删除 + operationId: guestdisk_CustomizeDelete + parameters: + - description: The Id or Name of guestdisk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestdisk_CustomizeDeleteOutput' + summary: 删除 + tags: + - guestdisk + get: + description: 获取详情 + operationId: guestdisk_FetchCustomizeColumns + parameters: + - description: The Id or Name of guestdisk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestdisk_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guestdisk + put: + description: 更新 + operationId: guestdisk_ValidateUpdateData + parameters: + - description: The Id or Name of guestdisk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestdiskUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestdisk_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guestdisk + /guestdisks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guestdisk_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guestdisk_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guestdisk + /guestdisks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guestdisk_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guestdisk: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestdisk_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guestdisk + /guestdisks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guestdisk_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guestdisk_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guestdisk + /guestdisks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guestdisk_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/guestdisk_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guestdisk + /guestnetworks: + get: + description: 列表 + operationId: guestnetwork_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - in: query + items: + type: string + name: mac_addr + type: array + x-go-name: MacAddr + - in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - in: query + items: + type: string + name: ip6_addr + type: array + x-go-name: Ip6Addr + - in: query + items: + type: string + name: driver + type: array + x-go-name: Driver + - in: query + items: + type: string + name: ifname + type: array + x-go-name: Ifname + - in: query + items: + type: string + name: team_with + type: array + x-go-name: TeamWith + responses: + "200": + $ref: '#/responses/guestnetwork_ListItemFilterOutput' + summary: 列表 + tags: + - guestnetwork + post: + description: 新建 + operationId: guestnetwork_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guestnetwork: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestnetwork_ValidateCreateDataOutput' + summary: 新建 + tags: + - guestnetwork + /guestnetworks/{id}: + delete: + description: 删除 + operationId: guestnetwork_CustomizeDelete + parameters: + - description: The Id or Name of guestnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestnetwork_CustomizeDeleteOutput' + summary: 删除 + tags: + - guestnetwork + get: + description: 获取详情 + operationId: guestnetwork_FetchCustomizeColumns + parameters: + - description: The Id or Name of guestnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestnetwork_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guestnetwork + put: + description: 更新 + operationId: guestnetwork_ValidateUpdateData + parameters: + - description: The Id or Name of guestnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestnetwork_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guestnetwork + /guestnetworks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guestnetwork_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guestnetwork_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guestnetwork + /guestnetworks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guestnetwork_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guestnetwork: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestnetwork_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guestnetwork + /guestnetworks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guestnetwork_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guestnetwork_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guestnetwork + /guestnetworks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guestnetwork_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/guestnetwork_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guestnetwork + /guestsecgroups: + get: + description: 列表 + operationId: guestsecgroup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + responses: + "200": + $ref: '#/responses/guestsecgroup_ListItemFilterOutput' + summary: 列表 + tags: + - guestsecgroup + post: + description: 新建 + operationId: guestsecgroup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guestsecgroup: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestsecgroup_ValidateCreateDataOutput' + summary: 新建 + tags: + - guestsecgroup + /guestsecgroups/{id}: + delete: + description: 删除 + operationId: guestsecgroup_CustomizeDelete + parameters: + - description: The Id or Name of guestsecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestsecgroup_CustomizeDeleteOutput' + summary: 删除 + tags: + - guestsecgroup + get: + description: 获取详情 + operationId: guestsecgroup_FetchCustomizeColumns + parameters: + - description: The Id or Name of guestsecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guestsecgroup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guestsecgroup + put: + description: 更新 + operationId: guestsecgroup_ValidateUpdateData + parameters: + - description: The Id or Name of guestsecgroup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestJointBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestsecgroup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guestsecgroup + /guestsecgroups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guestsecgroup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guestsecgroup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guestsecgroup + /guestsecgroups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guestsecgroup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guestsecgroup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guestsecgroup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guestsecgroup + /guestsecgroups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guestsecgroup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guestsecgroup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guestsecgroup + /guestsecgroups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guestsecgroup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/guestsecgroup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guestsecgroup + /hostnetworks: + get: + description: 列表 + operationId: hostnetwork_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: IP地址 + in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - description: MAC地址 + in: query + items: + type: string + name: mac_addr + type: array + x-go-name: MacAddr + responses: + "200": + $ref: '#/responses/hostnetwork_ListItemFilterOutput' + summary: 列表 + tags: + - hostnetwork + post: + description: 新建 + operationId: hostnetwork_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + hostnetwork: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostnetwork_ValidateCreateDataOutput' + summary: 新建 + tags: + - hostnetwork + /hostnetworks/{id}: + delete: + description: 删除 + operationId: hostnetwork_CustomizeDelete + parameters: + - description: The Id or Name of hostnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hostnetwork_CustomizeDeleteOutput' + summary: 删除 + tags: + - hostnetwork + get: + description: 获取详情 + operationId: hostnetwork_FetchCustomizeColumns + parameters: + - description: The Id or Name of hostnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hostnetwork_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - hostnetwork + put: + description: 更新 + operationId: hostnetwork_ValidateUpdateData + parameters: + - description: The Id or Name of hostnetwork + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + hostnetwork: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostnetwork_ValidateUpdateDataOutput' + summary: 更新 + tags: + - hostnetwork + /hostnetworks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: hostnetwork_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/hostnetwork_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - hostnetwork + /hostnetworks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: hostnetwork_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + hostnetwork: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostnetwork_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - hostnetwork + /hostnetworks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: hostnetwork_GetPropertySplitable + responses: + "200": + $ref: '#/responses/hostnetwork_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - hostnetwork + /hostnetworks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: hostnetwork_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/hostnetwork_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - hostnetwork + /hosts: + get: + description: 列表 + operationId: host_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by ResourceType + in: query + name: resource_type + type: string + x-go-name: ResourceType + - description: filter by mac of any network interface + in: query + name: any_mac + type: string + x-go-name: AnyMac + - description: filter by ip of any network interface + in: query + name: any_ip + type: string + x-go-name: AnyIp + - description: filter storages not attached to this host + in: query + name: storage_not_attached + type: boolean + x-go-name: StorageNotAttached + - description: filter by Hypervisor + in: query + name: hypervisor + type: string + x-go-name: Hypervisor + - description: filter host that is empty + in: query + name: is_empty + type: boolean + x-go-name: IsEmpty + - description: filter host that is baremetal + in: query + name: baremetal + type: boolean + x-go-name: Baremetal + - description: 机架 + in: query + items: + type: string + name: rack + type: array + x-go-name: Rack + - description: 机位 + in: query + items: + type: string + name: slots + type: array + x-go-name: Slots + - description: 管理口MAC + in: query + items: + type: string + name: access_mac + type: array + x-go-name: AccessMac + - description: 管理口Ip地址 + in: query + items: + type: string + name: access_ip + type: array + x-go-name: AccessIp + - description: 物理机序列号信息 + in: query + items: + type: string + name: sn + type: array + x-go-name: SN + - description: CPU大小 + in: query + items: + format: int64 + type: integer + name: cpu_count + type: array + x-go-name: CpuCount + - description: 内存大小,单位Mb + in: query + items: + format: int64 + type: integer + name: mem_size + type: array + x-go-name: MemSize + - description: 存储类型 + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - description: IPMI地址 + in: query + items: + type: string + name: ipmi_ip + type: array + x-go-name: IpmiIp + - description: 宿主机状态 + example: online + in: query + items: + type: string + name: host_status + type: array + x-go-name: HostStatus + - description: 宿主机类型 + in: query + items: + type: string + name: host_type + type: array + x-go-name: HostType + - description: host服务软件版本 + in: query + items: + type: string + name: version + type: array + x-go-name: Version + - description: OVN软件版本 + in: query + items: + type: string + name: ovn_version + type: array + x-go-name: OvnVersion + - description: 是否处于维护状态 + in: query + name: is_maintenance + type: boolean + x-go-name: IsMaintenance + - description: 是否为导入的宿主机 + in: query + name: is_import + type: boolean + x-go-name: IsImport + - description: 是否允许PXE启动 + in: query + name: enable_pxe_boot + type: boolean + x-go-name: EnablePxeBoot + - description: 主机UUID + in: query + items: + type: string + name: uuid + type: array + x-go-name: Uuid + - description: 主机启动模式, 可能值位PXE和ISO + in: query + items: + type: string + name: boot_mode + type: array + x-go-name: BootMode + - description: 虚拟机所在的二层网络 + in: query + name: server_id_for_network + type: string + x-go-name: ServerIdForNetwork + - description: 宿主机 cpu 架构 + in: query + items: + type: string + name: cpu_architecture + type: array + x-go-name: CpuArchitecture + - in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 按虚拟机数量排序 + enum: + - asc + - desc + in: query + name: order_by_server_count + type: string + x-go-name: OrderByServerCount + - description: |- + 按存储大小排序 + enmu: asc,desc + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: |- + 按存储超分率排序 + enmu: asc,desc + in: query + name: order_by_storage_commit_rate + type: string + x-go-name: OrderByStorageCommitRate + - description: |- + 按cpu超分率排序 + enmu: asc,desc + in: query + name: order_by_cpu_commit_rate + type: string + x-go-name: OrderByCpuCommitRate + - description: |- + 按内存超分率排序 + enmu: asc,desc + in: query + name: order_by_mem_commit_rate + type: string + x-go-name: OrderByMemCommitRate + responses: + "200": + $ref: '#/responses/host_ListItemFilterOutput' + summary: 宿主机/物理机列表 + tags: + - host + post: + description: 新建 + operationId: host_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + host: + $ref: '#/definitions/HostCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_ValidateCreateDataOutput' + summary: 新建 + tags: + - host + /hosts/{id}: + delete: + description: 删除 + operationId: host_CustomizeDelete + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_CustomizeDeleteOutput' + summary: 删除 + tags: + - host + get: + description: 获取详情 + operationId: host_FetchCustomizeColumns + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - host + put: + description: 更新 + operationId: host_ValidateUpdateData + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_ValidateUpdateDataOutput' + summary: 更新 + tags: + - host + /hosts/{id}/add-netif: + post: + description: 执行操作AddNetif + operationId: host_PerformAddNetif + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformAddNetifOutput' + summary: 执行操作AddNetif + tags: + - host + /hosts/{id}/app-options: + get: + description: 获取指定信息AppOptions + operationId: host_GetDetailsAppOptions + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsAppOptionsOutput' + summary: 获取指定信息AppOptions + tags: + - host + /hosts/{id}/auto-migrate-on-host-down: + post: + description: 执行操作AutoMigrateOnHostDown + operationId: host_PerformAutoMigrateOnHostDown + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostAutoMigrateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformAutoMigrateOnHostDownOutput' + summary: 执行操作AutoMigrateOnHostDown + tags: + - host + /hosts/{id}/cache-image: + post: + description: 执行操作CacheImage + operationId: host_PerformCacheImage + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/CacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformCacheImageOutput' + summary: 执行操作CacheImage + tags: + - host + /hosts/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: host_PerformChangeOwner + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - host + /hosts/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: host_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - host + /hosts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: host_GetDetailsClassMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - host + post: + description: 执行操作ClassMetadata + operationId: host_PerformClassMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - host + /hosts/{id}/convert-hypervisor: + post: + description: 执行操作ConvertHypervisor + operationId: host_PerformConvertHypervisor + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformConvertHypervisorOutput' + summary: 执行操作ConvertHypervisor + tags: + - host + /hosts/{id}/disable: + post: + description: 执行操作Disable + operationId: host_PerformDisable + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformDisableOutput' + summary: 执行操作Disable + tags: + - host + /hosts/{id}/disable-netif: + post: + description: 执行操作DisableNetif + operationId: host_PerformDisableNetif + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformDisableNetifOutput' + summary: 执行操作DisableNetif + tags: + - host + /hosts/{id}/eject-iso: + post: + description: 执行操作EjectIso + operationId: host_PerformEjectIso + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformEjectIsoOutput' + summary: 执行操作EjectIso + tags: + - host + /hosts/{id}/enable: + post: + description: 执行操作Enable + operationId: host_PerformEnable + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformEnableOutput' + summary: 执行操作Enable + tags: + - host + /hosts/{id}/enable-netif: + post: + description: 执行操作EnableNetif + operationId: host_PerformEnableNetif + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformEnableNetifOutput' + summary: 执行操作EnableNetif + tags: + - host + /hosts/{id}/host-exit-maintenance: + post: + description: 执行操作HostExitMaintenance + operationId: host_PerformHostExitMaintenance + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformHostExitMaintenanceOutput' + summary: 执行操作HostExitMaintenance + tags: + - host + /hosts/{id}/host-maintenance: + post: + description: 执行操作HostMaintenance + operationId: host_PerformHostMaintenance + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformHostMaintenanceOutput' + summary: 执行操作HostMaintenance + tags: + - host + /hosts/{id}/initialize: + post: + description: 执行操作Initialize + operationId: host_PerformInitialize + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformInitializeOutput' + summary: 执行操作Initialize + tags: + - host + /hosts/{id}/insert-iso: + post: + description: 执行操作InsertIso + operationId: host_PerformInsertIso + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformInsertIsoOutput' + summary: 执行操作InsertIso + tags: + - host + /hosts/{id}/ipmi: + get: + description: 获取指定信息Ipmi + operationId: host_GetDetailsIpmi + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsIpmiOutput' + summary: 获取指定信息Ipmi + tags: + - host + /hosts/{id}/ipmi-probe: + post: + description: 执行操作IpmiProbe + operationId: host_PerformIpmiProbe + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformIpmiProbeOutput' + summary: 执行操作IpmiProbe + tags: + - host + /hosts/{id}/jnlp: + get: + description: 获取指定信息Jnlp + operationId: host_GetDetailsJnlp + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsJnlpOutput' + summary: 获取指定信息Jnlp + tags: + - host + /hosts/{id}/maintenance: + post: + description: 执行操作Maintenance + operationId: host_PerformMaintenance + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformMaintenanceOutput' + summary: 执行操作Maintenance + tags: + - host + /hosts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: host_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - host + /hosts/{id}/offline: + post: + description: 执行操作Offline + operationId: host_PerformOffline + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostOfflineInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformOfflineOutput' + summary: 执行操作Offline + tags: + - host + /hosts/{id}/online: + post: + description: 执行操作Online + operationId: host_PerformOnline + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformOnlineOutput' + summary: 执行操作Online + tags: + - host + /hosts/{id}/ping: + post: + description: 执行操作Ping + operationId: host_PerformPing + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/SHostPingInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformPingOutput' + summary: 执行操作Ping + tags: + - host + /hosts/{id}/prepare: + post: + description: 执行操作Prepare + operationId: host_PerformPrepare + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformPrepareOutput' + summary: 执行操作Prepare + tags: + - host + /hosts/{id}/private: + post: + description: 执行操作Private + operationId: host_PerformPrivate + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformPrivateOutput' + summary: 执行操作Private + tags: + - host + /hosts/{id}/probe-isolated-devices: + post: + description: 执行操作ProbeIsolatedDevices + operationId: host_PerformProbeIsolatedDevices + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformProbeIsolatedDevicesOutput' + summary: 执行操作ProbeIsolatedDevices + tags: + - host + /hosts/{id}/public: + post: + description: 执行操作Public + operationId: host_PerformPublic + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformPublicOutput' + summary: 执行操作Public + tags: + - host + /hosts/{id}/remove-all-netifs: + post: + description: 执行操作RemoveAllNetifs + operationId: host_PerformRemoveAllNetifs + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformRemoveAllNetifsOutput' + summary: 执行操作RemoveAllNetifs + tags: + - host + /hosts/{id}/remove-netif: + post: + description: 执行操作RemoveNetif + operationId: host_PerformRemoveNetif + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformRemoveNetifOutput' + summary: 执行操作RemoveNetif + tags: + - host + /hosts/{id}/renew-prepaid-recycle: + post: + description: 执行操作RenewPrepaidRecycle + operationId: host_PerformRenewPrepaidRecycle + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformRenewPrepaidRecycleOutput' + summary: 执行操作RenewPrepaidRecycle + tags: + - host + /hosts/{id}/reserve-cpus: + post: + description: 执行操作ReserveCpus + operationId: host_PerformReserveCpus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/HostReserveCpusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformReserveCpusOutput' + summary: 执行操作ReserveCpus + tags: + - host + /hosts/{id}/reset: + post: + description: 执行操作Reset + operationId: host_PerformReset + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformResetOutput' + summary: 执行操作Reset + tags: + - host + /hosts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: host_PerformSetClassMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - host + /hosts/{id}/set-reserved-resource-for-isolated-device: + post: + description: 执行操作SetReservedResourceForIsolatedDevice + operationId: host_PerformSetReservedResourceForIsolatedDevice + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/IsolatedDeviceReservedResourceInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformSetReservedResourceForIsolatedDeviceOutput' + summary: 执行操作SetReservedResourceForIsolatedDevice + tags: + - host + /hosts/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: host_PerformSetSchedtag + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - host + /hosts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: host_PerformSetUserMetadata + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - host + /hosts/{id}/spec: + get: + description: 获取指定信息Spec + operationId: host_GetDetailsSpec + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsSpecOutput' + summary: 获取指定信息Spec + tags: + - host + /hosts/{id}/start: + post: + description: 执行操作Start + operationId: host_PerformStart + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformStartOutput' + summary: 执行操作Start + tags: + - host + /hosts/{id}/status: + get: + description: 获取指定信息Status + operationId: host_GetDetailsStatus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - host + post: + description: 执行操作Status + operationId: host_PerformStatus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformStatusOutput' + summary: 执行操作Status + tags: + - host + /hosts/{id}/stop: + post: + description: 执行操作Stop + operationId: host_PerformStop + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformStopOutput' + summary: 执行操作Stop + tags: + - host + /hosts/{id}/sync-config: + post: + description: 执行操作SyncConfig + operationId: host_PerformSyncConfig + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformSyncConfigOutput' + summary: 执行操作SyncConfig + tags: + - host + /hosts/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: host_PerformSyncstatus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - host + /hosts/{id}/tap-config: + get: + description: 获取指定信息TapConfig + operationId: host_GetDetailsTapConfig + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsTapConfigOutput' + summary: 获取指定信息TapConfig + tags: + - host + /hosts/{id}/undo-convert: + post: + description: 执行操作UndoConvert + operationId: host_PerformUndoConvert + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUndoConvertOutput' + summary: 执行操作UndoConvert + tags: + - host + /hosts/{id}/undo-prepaid-recycle: + post: + description: 执行操作UndoPrepaidRecycle + operationId: host_PerformUndoPrepaidRecycle + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUndoPrepaidRecycleOutput' + summary: 执行操作UndoPrepaidRecycle + tags: + - host + /hosts/{id}/unmaintenance: + post: + description: 执行操作Unmaintenance + operationId: host_PerformUnmaintenance + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUnmaintenanceOutput' + summary: 执行操作Unmaintenance + tags: + - host + /hosts/{id}/unreserve-cpus: + post: + description: 执行操作UnreserveCpus + operationId: host_PerformUnreserveCpus + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUnreserveCpusOutput' + summary: 执行操作UnreserveCpus + tags: + - host + /hosts/{id}/update-storage: + post: + description: 执行操作UpdateStorage + operationId: host_PerformUpdateStorage + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_PerformUpdateStorageOutput' + summary: 执行操作UpdateStorage + tags: + - host + /hosts/{id}/vnc: + get: + description: 获取指定信息Vnc + operationId: host_GetDetailsVnc + parameters: + - description: The Id or Name of host + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/host_GetDetailsVncOutput' + summary: 获取指定信息Vnc + tags: + - host + /hosts/bm-start-register-script: + get: + description: 获取指定资源类的信息BmStartRegisterScript + operationId: host_GetPropertyBmStartRegisterScript + responses: + "200": + $ref: '#/responses/host_GetPropertyBmStartRegisterScriptOutput' + summary: 获取指定资源类的信息BmStartRegisterScript + tags: + - host + /hosts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: host_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/host_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - host + /hosts/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: host_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/host_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - host + /hosts/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: host_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/host_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - host + /hosts/host-type-count: + get: + description: 获取指定资源类的信息HostTypeCount + operationId: host_GetPropertyHostTypeCount + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by ResourceType + in: query + name: resource_type + type: string + x-go-name: ResourceType + - description: filter by mac of any network interface + in: query + name: any_mac + type: string + x-go-name: AnyMac + - description: filter by ip of any network interface + in: query + name: any_ip + type: string + x-go-name: AnyIp + - description: filter storages not attached to this host + in: query + name: storage_not_attached + type: boolean + x-go-name: StorageNotAttached + - description: filter by Hypervisor + in: query + name: hypervisor + type: string + x-go-name: Hypervisor + - description: filter host that is empty + in: query + name: is_empty + type: boolean + x-go-name: IsEmpty + - description: filter host that is baremetal + in: query + name: baremetal + type: boolean + x-go-name: Baremetal + - description: 机架 + in: query + items: + type: string + name: rack + type: array + x-go-name: Rack + - description: 机位 + in: query + items: + type: string + name: slots + type: array + x-go-name: Slots + - description: 管理口MAC + in: query + items: + type: string + name: access_mac + type: array + x-go-name: AccessMac + - description: 管理口Ip地址 + in: query + items: + type: string + name: access_ip + type: array + x-go-name: AccessIp + - description: 物理机序列号信息 + in: query + items: + type: string + name: sn + type: array + x-go-name: SN + - description: CPU大小 + in: query + items: + format: int64 + type: integer + name: cpu_count + type: array + x-go-name: CpuCount + - description: 内存大小,单位Mb + in: query + items: + format: int64 + type: integer + name: mem_size + type: array + x-go-name: MemSize + - description: 存储类型 + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - description: IPMI地址 + in: query + items: + type: string + name: ipmi_ip + type: array + x-go-name: IpmiIp + - description: 宿主机状态 + example: online + in: query + items: + type: string + name: host_status + type: array + x-go-name: HostStatus + - description: 宿主机类型 + in: query + items: + type: string + name: host_type + type: array + x-go-name: HostType + - description: host服务软件版本 + in: query + items: + type: string + name: version + type: array + x-go-name: Version + - description: OVN软件版本 + in: query + items: + type: string + name: ovn_version + type: array + x-go-name: OvnVersion + - description: 是否处于维护状态 + in: query + name: is_maintenance + type: boolean + x-go-name: IsMaintenance + - description: 是否为导入的宿主机 + in: query + name: is_import + type: boolean + x-go-name: IsImport + - description: 是否允许PXE启动 + in: query + name: enable_pxe_boot + type: boolean + x-go-name: EnablePxeBoot + - description: 主机UUID + in: query + items: + type: string + name: uuid + type: array + x-go-name: Uuid + - description: 主机启动模式, 可能值位PXE和ISO + in: query + items: + type: string + name: boot_mode + type: array + x-go-name: BootMode + - description: 虚拟机所在的二层网络 + in: query + name: server_id_for_network + type: string + x-go-name: ServerIdForNetwork + - description: 宿主机 cpu 架构 + in: query + items: + type: string + name: cpu_architecture + type: array + x-go-name: CpuArchitecture + - in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 按虚拟机数量排序 + enum: + - asc + - desc + in: query + name: order_by_server_count + type: string + x-go-name: OrderByServerCount + - description: |- + 按存储大小排序 + enmu: asc,desc + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: |- + 按存储超分率排序 + enmu: asc,desc + in: query + name: order_by_storage_commit_rate + type: string + x-go-name: OrderByStorageCommitRate + - description: |- + 按cpu超分率排序 + enmu: asc,desc + in: query + name: order_by_cpu_commit_rate + type: string + x-go-name: OrderByCpuCommitRate + - description: |- + 按内存超分率排序 + enmu: asc,desc + in: query + name: order_by_mem_commit_rate + type: string + x-go-name: OrderByMemCommitRate + responses: + "200": + $ref: '#/responses/host_GetPropertyHostTypeCountOutput' + summary: 获取指定资源类的信息HostTypeCount + tags: + - host + /hosts/k8s-master-node-ips: + get: + description: 获取指定资源类的信息K8sMasterNodeIps + operationId: host_GetPropertyK8sMasterNodeIps + responses: + "200": + $ref: '#/responses/host_GetPropertyK8sMasterNodeIpsOutput' + summary: 获取指定资源类的信息K8sMasterNodeIps + tags: + - host + /hosts/node-count: + get: + description: 获取指定资源类的信息NodeCount + operationId: host_GetPropertyNodeCount + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by ResourceType + in: query + name: resource_type + type: string + x-go-name: ResourceType + - description: filter by mac of any network interface + in: query + name: any_mac + type: string + x-go-name: AnyMac + - description: filter by ip of any network interface + in: query + name: any_ip + type: string + x-go-name: AnyIp + - description: filter storages not attached to this host + in: query + name: storage_not_attached + type: boolean + x-go-name: StorageNotAttached + - description: filter by Hypervisor + in: query + name: hypervisor + type: string + x-go-name: Hypervisor + - description: filter host that is empty + in: query + name: is_empty + type: boolean + x-go-name: IsEmpty + - description: filter host that is baremetal + in: query + name: baremetal + type: boolean + x-go-name: Baremetal + - description: 机架 + in: query + items: + type: string + name: rack + type: array + x-go-name: Rack + - description: 机位 + in: query + items: + type: string + name: slots + type: array + x-go-name: Slots + - description: 管理口MAC + in: query + items: + type: string + name: access_mac + type: array + x-go-name: AccessMac + - description: 管理口Ip地址 + in: query + items: + type: string + name: access_ip + type: array + x-go-name: AccessIp + - description: 物理机序列号信息 + in: query + items: + type: string + name: sn + type: array + x-go-name: SN + - description: CPU大小 + in: query + items: + format: int64 + type: integer + name: cpu_count + type: array + x-go-name: CpuCount + - description: 内存大小,单位Mb + in: query + items: + format: int64 + type: integer + name: mem_size + type: array + x-go-name: MemSize + - description: 存储类型 + in: query + items: + type: string + name: storage_type + type: array + x-go-name: StorageType + - description: IPMI地址 + in: query + items: + type: string + name: ipmi_ip + type: array + x-go-name: IpmiIp + - description: 宿主机状态 + example: online + in: query + items: + type: string + name: host_status + type: array + x-go-name: HostStatus + - description: 宿主机类型 + in: query + items: + type: string + name: host_type + type: array + x-go-name: HostType + - description: host服务软件版本 + in: query + items: + type: string + name: version + type: array + x-go-name: Version + - description: OVN软件版本 + in: query + items: + type: string + name: ovn_version + type: array + x-go-name: OvnVersion + - description: 是否处于维护状态 + in: query + name: is_maintenance + type: boolean + x-go-name: IsMaintenance + - description: 是否为导入的宿主机 + in: query + name: is_import + type: boolean + x-go-name: IsImport + - description: 是否允许PXE启动 + in: query + name: enable_pxe_boot + type: boolean + x-go-name: EnablePxeBoot + - description: 主机UUID + in: query + items: + type: string + name: uuid + type: array + x-go-name: Uuid + - description: 主机启动模式, 可能值位PXE和ISO + in: query + items: + type: string + name: boot_mode + type: array + x-go-name: BootMode + - description: 虚拟机所在的二层网络 + in: query + name: server_id_for_network + type: string + x-go-name: ServerIdForNetwork + - description: 宿主机 cpu 架构 + in: query + items: + type: string + name: cpu_architecture + type: array + x-go-name: CpuArchitecture + - in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 按虚拟机数量排序 + enum: + - asc + - desc + in: query + name: order_by_server_count + type: string + x-go-name: OrderByServerCount + - description: |- + 按存储大小排序 + enmu: asc,desc + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: |- + 按存储超分率排序 + enmu: asc,desc + in: query + name: order_by_storage_commit_rate + type: string + x-go-name: OrderByStorageCommitRate + - description: |- + 按cpu超分率排序 + enmu: asc,desc + in: query + name: order_by_cpu_commit_rate + type: string + x-go-name: OrderByCpuCommitRate + - description: |- + 按内存超分率排序 + enmu: asc,desc + in: query + name: order_by_mem_commit_rate + type: string + x-go-name: OrderByMemCommitRate + responses: + "200": + $ref: '#/responses/host_GetPropertyNodeCountOutput' + summary: 获取指定资源类的信息NodeCount + tags: + - host + /hosts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: host_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + host: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/host_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - host + /hosts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: host_GetPropertySplitable + responses: + "200": + $ref: '#/responses/host_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - host + /hosts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: host_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/host_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - host + /hosts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: host_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/host_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - host + /hosts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: host_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/host_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - host + /hosts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: host_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/host_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - host + /hoststorages: + get: + description: 列表 + operationId: hoststorage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/hoststorage_ListItemFilterOutput' + summary: 列表 + tags: + - hoststorage + post: + description: 新建 + operationId: hoststorage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + hoststorage: + $ref: '#/definitions/HostStorageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hoststorage_ValidateCreateDataOutput' + summary: 新建 + tags: + - hoststorage + /hoststorages/{id}: + delete: + description: 删除 + operationId: hoststorage_CustomizeDelete + parameters: + - description: The Id or Name of hoststorage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hoststorage_CustomizeDeleteOutput' + summary: 删除 + tags: + - hoststorage + get: + description: 获取详情 + operationId: hoststorage_FetchCustomizeColumns + parameters: + - description: The Id or Name of hoststorage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hoststorage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - hoststorage + put: + description: 更新 + operationId: hoststorage_ValidateUpdateData + parameters: + - description: The Id or Name of hoststorage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + hoststorage: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hoststorage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - hoststorage + /hoststorages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: hoststorage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/hoststorage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - hoststorage + /hoststorages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: hoststorage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + hoststorage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hoststorage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - hoststorage + /hoststorages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: hoststorage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/hoststorage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - hoststorage + /hoststorages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: hoststorage_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/hoststorage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - hoststorage + /hostwires: + get: + description: 列表 + operationId: hostwire_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 网桥名称 + in: query + items: + type: string + name: bridge + type: array + x-go-name: Bridge + - description: 接口名称 + in: query + items: + type: string + name: interface + type: array + x-go-name: Interface + - description: 是否是主网口 + in: query + name: is_master + type: boolean + x-go-name: IsMaster + - description: MAC地址 + in: query + items: + type: string + name: mac_addr + type: array + x-go-name: MacAddr + responses: + "200": + $ref: '#/responses/hostwire_ListItemFilterOutput' + summary: 列表 + tags: + - hostwire + post: + description: 新建 + operationId: hostwire_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + hostwire: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostwire_ValidateCreateDataOutput' + summary: 新建 + tags: + - hostwire + /hostwires/{id}: + delete: + description: 删除 + operationId: hostwire_CustomizeDelete + parameters: + - description: The Id or Name of hostwire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hostwire_CustomizeDeleteOutput' + summary: 删除 + tags: + - hostwire + get: + description: 获取详情 + operationId: hostwire_FetchCustomizeColumns + parameters: + - description: The Id or Name of hostwire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/hostwire_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - hostwire + put: + description: 更新 + operationId: hostwire_ValidateUpdateData + parameters: + - description: The Id or Name of hostwire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + hostwire: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostwire_ValidateUpdateDataOutput' + summary: 更新 + tags: + - hostwire + /hostwires/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: hostwire_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/hostwire_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - hostwire + /hostwires/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: hostwire_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + hostwire: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/hostwire_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - hostwire + /hostwires/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: hostwire_GetPropertySplitable + responses: + "200": + $ref: '#/responses/hostwire_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - hostwire + /hostwires/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: hostwire_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/hostwire_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - hostwire + /infras_quotas/domains: + get: + description: 获取所有域的基础设施配额 + operationId: models_ListInfrasQuotas + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + responses: + "200": + $ref: '#/responses/models_ListInfrasQuotasOutput' + summary: 获取所有域的基础设施配额 + tags: + - infras_quota + /infras_quotas/domains/{domainId}: + get: + description: 获取指定域的基础设施配额 + operationId: models_GetInfrasQuota + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 指定域的ID + in: path + name: domainId + required: true + type: string + x-go-name: DomainId + responses: + "200": + $ref: '#/responses/models_GetInfrasQuotaOutput' + summary: 获取指定域的基础设施配额 + tags: + - infras_quota + post: + description: 设置指定域的基础设施配额 + operationId: models_SetInfrasQuotas + parameters: + - description: 指定域的ID + in: path + name: domainId + required: true + type: string + x-go-name: DomainId + - in: body + name: body + schema: + properties: + infras_quotas: + $ref: '#/definitions/SetInfrasQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetInfrasQuotasOutput' + summary: 设置指定域的基础设施配额 + tags: + - infras_quota + /instance_backups: + get: + description: 列表 + operationId: instance_backup_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 按虚拟机名称排序 + in: query + name: order_by_guest + pattern: asc|desc + type: string + x-go-name: OrderByGuest + - description: 操作系统类型 + in: query + items: + type: string + name: os_type + type: array + x-go-name: OsType + responses: + "200": + $ref: '#/responses/instance_backup_ListItemFilterOutput' + summary: 列表 + tags: + - instance_backup + post: + description: 新建 + operationId: instance_backup_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + instance_backup: + $ref: '#/definitions/InstanceBackupManagerCreateFromPackageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_ValidateCreateDataOutput' + summary: 新建 + tags: + - instance_backup + /instance_backups/{id}: + delete: + description: 删除 + operationId: instance_backup_CustomizeDelete + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_CustomizeDeleteOutput' + summary: 删除 + tags: + - instance_backup + get: + description: 获取详情 + operationId: instance_backup_FetchCustomizeColumns + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - instance_backup + put: + description: 更新 + operationId: instance_backup_ValidateUpdateData + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_ValidateUpdateDataOutput' + summary: 更新 + tags: + - instance_backup + /instance_backups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: instance_backup_PerformCancelDelete + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - instance_backup + /instance_backups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: instance_backup_PerformChangeOwner + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - instance_backup + /instance_backups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: instance_backup_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - instance_backup + /instance_backups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: instance_backup_GetDetailsClassMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - instance_backup + post: + description: 执行操作ClassMetadata + operationId: instance_backup_PerformClassMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - instance_backup + /instance_backups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: instance_backup_PerformFreeze + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - instance_backup + /instance_backups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: instance_backup_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - instance_backup + /instance_backups/{id}/pack: + post: + description: 执行操作Pack + operationId: instance_backup_PerformPack + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupPackInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformPackOutput' + summary: 执行操作Pack + tags: + - instance_backup + /instance_backups/{id}/recovery: + post: + description: 执行操作Recovery + operationId: instance_backup_PerformRecovery + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupRecoveryInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformRecoveryOutput' + summary: 执行操作Recovery + tags: + - instance_backup + /instance_backups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: instance_backup_PerformSetClassMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - instance_backup + /instance_backups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: instance_backup_PerformSetUserMetadata + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - instance_backup + /instance_backups/{id}/status: + get: + description: 获取指定信息Status + operationId: instance_backup_GetDetailsStatus + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_backup_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - instance_backup + post: + description: 执行操作Status + operationId: instance_backup_PerformStatus + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformStatusOutput' + summary: 更新资源状态 + tags: + - instance_backup + /instance_backups/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: instance_backup_PerformSyncstatus + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupManagerSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - instance_backup + /instance_backups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: instance_backup_PerformUnfreeze + parameters: + - description: The Id or Name of instance_backup + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - instance_backup + /instance_backups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: instance_backup_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - instance_backup + /instance_backups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: instance_backup_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - instance_backup + /instance_backups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: instance_backup_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - instance_backup + /instance_backups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: instance_backup_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - instance_backup + /instance_backups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: instance_backup_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - instance_backup + /instance_backups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: instance_backup_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + instance_backup: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_backup_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - instance_backup + /instance_backups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: instance_backup_GetPropertySplitable + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - instance_backup + /instance_backups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: instance_backup_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - instance_backup + /instance_backups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: instance_backup_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - instance_backup + /instance_backups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: instance_backup_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - instance_backup + /instance_backups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: instance_backup_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/instance_backup_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - instance_backup + /instance_snapshots: + get: + description: 列表 + operationId: instance_snapshot_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + - description: 操作系统类型 + in: query + items: + type: string + name: os_type + type: array + x-go-name: OsType + - description: 包含内存快照 + in: query + name: with_memory + type: boolean + x-go-name: WithMemory + - description: 按磁盘快照数量排序 + in: query + name: order_by_disk_snapshot_count + pattern: asc|desc + type: string + x-go-name: OrderByDiskSnapshotCount + - description: 按虚拟机名称排序 + in: query + name: order_by_guest + pattern: asc|desc + type: string + x-go-name: OrderByGuest + responses: + "200": + $ref: '#/responses/instance_snapshot_ListItemFilterOutput' + summary: 主机快照列表 + tags: + - instance_snapshot + post: + description: 新建 + operationId: instance_snapshot_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + instance_snapshot: + $ref: '#/definitions/VirtualResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_ValidateCreateDataOutput' + summary: 新建 + tags: + - instance_snapshot + /instance_snapshots/{id}: + delete: + description: 删除 + operationId: instance_snapshot_CustomizeDelete + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_CustomizeDeleteOutput' + summary: 删除 + tags: + - instance_snapshot + get: + description: 获取详情 + operationId: instance_snapshot_FetchCustomizeColumns + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - instance_snapshot + put: + description: 更新 + operationId: instance_snapshot_ValidateUpdateData + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_ValidateUpdateDataOutput' + summary: 更新 + tags: + - instance_snapshot + /instance_snapshots/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: instance_snapshot_PerformCancelDelete + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - instance_snapshot + /instance_snapshots/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: instance_snapshot_PerformChangeOwner + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - instance_snapshot + /instance_snapshots/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: instance_snapshot_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - instance_snapshot + /instance_snapshots/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: instance_snapshot_GetDetailsClassMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - instance_snapshot + post: + description: 执行操作ClassMetadata + operationId: instance_snapshot_PerformClassMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - instance_snapshot + /instance_snapshots/{id}/freeze: + post: + description: 执行操作Freeze + operationId: instance_snapshot_PerformFreeze + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - instance_snapshot + /instance_snapshots/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: instance_snapshot_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - instance_snapshot + /instance_snapshots/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: instance_snapshot_PerformSetClassMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - instance_snapshot + /instance_snapshots/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: instance_snapshot_PerformSetUserMetadata + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - instance_snapshot + /instance_snapshots/{id}/status: + get: + description: 获取指定信息Status + operationId: instance_snapshot_GetDetailsStatus + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/instance_snapshot_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - instance_snapshot + post: + description: 执行操作Status + operationId: instance_snapshot_PerformStatus + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformStatusOutput' + summary: 更新资源状态 + tags: + - instance_snapshot + /instance_snapshots/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: instance_snapshot_PerformUnfreeze + parameters: + - description: The Id or Name of instance_snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - instance_snapshot + /instance_snapshots/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: instance_snapshot_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - instance_snapshot + /instance_snapshots/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: instance_snapshot_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - instance_snapshot + /instance_snapshots/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: instance_snapshot_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - instance_snapshot + /instance_snapshots/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: instance_snapshot_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - instance_snapshot + /instance_snapshots/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: instance_snapshot_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - instance_snapshot + /instance_snapshots/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: instance_snapshot_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + instance_snapshot: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/instance_snapshot_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - instance_snapshot + /instance_snapshots/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: instance_snapshot_GetPropertySplitable + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - instance_snapshot + /instance_snapshots/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: instance_snapshot_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - instance_snapshot + /instance_snapshots/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: instance_snapshot_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - instance_snapshot + /instance_snapshots/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: instance_snapshot_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - instance_snapshot + /instance_snapshots/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: instance_snapshot_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/instance_snapshot_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - instance_snapshot + /inter_vpc_network_route_sets: + get: + description: 列表 + operationId: inter_vpc_network_route_set_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: InterVpcNetworkId + type: string + - in: query + name: cidr + type: string + x-go-name: Cidr + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_ListItemFilterOutput' + summary: 列表 + tags: + - inter_vpc_network_route_set + post: + description: 新建 + operationId: inter_vpc_network_route_set_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + inter_vpc_network_route_set: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_ValidateCreateDataOutput' + summary: 新建 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}: + delete: + description: 删除 + operationId: inter_vpc_network_route_set_CustomizeDelete + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_CustomizeDeleteOutput' + summary: 删除 + tags: + - inter_vpc_network_route_set + get: + description: 获取详情 + operationId: inter_vpc_network_route_set_FetchCustomizeColumns + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - inter_vpc_network_route_set + put: + description: 更新 + operationId: inter_vpc_network_route_set_ValidateUpdateData + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_ValidateUpdateDataOutput' + summary: 更新 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: inter_vpc_network_route_set_GetDetailsClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - inter_vpc_network_route_set + post: + description: 执行操作ClassMetadata + operationId: inter_vpc_network_route_set_PerformClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/disable: + post: + description: 执行操作Disable + operationId: inter_vpc_network_route_set_PerformDisable + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformDisableOutput' + summary: 执行操作Disable + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/enable: + post: + description: 执行操作Enable + operationId: inter_vpc_network_route_set_PerformEnable + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformEnableOutput' + summary: 执行操作Enable + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: inter_vpc_network_route_set_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: inter_vpc_network_route_set_PerformSetClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: inter_vpc_network_route_set_PerformSetUserMetadata + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/{id}/status: + get: + description: 获取指定信息Status + operationId: inter_vpc_network_route_set_GetDetailsStatus + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - inter_vpc_network_route_set + post: + description: 执行操作Status + operationId: inter_vpc_network_route_set_PerformStatus + parameters: + - description: The Id or Name of inter_vpc_network_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformStatusOutput' + summary: 更新资源状态 + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: inter_vpc_network_route_set_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: inter_vpc_network_route_set_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: inter_vpc_network_route_set_GetPropertySplitable + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: inter_vpc_network_route_set_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: inter_vpc_network_route_set_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: inter_vpc_network_route_set_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - inter_vpc_network_route_set + /inter_vpc_network_route_sets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: inter_vpc_network_route_set_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/inter_vpc_network_route_set_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - inter_vpc_network_route_set + /inter_vpc_network_vpcs: + get: + description: 列表 + operationId: inter_vpc_network_vpc_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_ListItemFilterOutput' + summary: 列表 + tags: + - inter_vpc_network_vpc + post: + description: 新建 + operationId: inter_vpc_network_vpc_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + inter_vpc_network_vpc: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_ValidateCreateDataOutput' + summary: 新建 + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/{id}: + delete: + description: 删除 + operationId: inter_vpc_network_vpc_CustomizeDelete + parameters: + - description: The Id or Name of inter_vpc_network_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_CustomizeDeleteOutput' + summary: 删除 + tags: + - inter_vpc_network_vpc + get: + description: 获取详情 + operationId: inter_vpc_network_vpc_FetchCustomizeColumns + parameters: + - description: The Id or Name of inter_vpc_network_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - inter_vpc_network_vpc + put: + description: 更新 + operationId: inter_vpc_network_vpc_ValidateUpdateData + parameters: + - description: The Id or Name of inter_vpc_network_vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_ValidateUpdateDataOutput' + summary: 更新 + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: inter_vpc_network_vpc_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: inter_vpc_network_vpc_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: inter_vpc_network_vpc_GetPropertySplitable + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - inter_vpc_network_vpc + /inter_vpc_network_vpcs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: inter_vpc_network_vpc_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/inter_vpc_network_vpc_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - inter_vpc_network_vpc + /inter_vpc_networks: + get: + description: 列表 + operationId: inter_vpc_network_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/inter_vpc_network_ListItemFilterOutput' + summary: 列表 + tags: + - inter_vpc_network + post: + description: 新建 + operationId: inter_vpc_network_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_ValidateCreateDataOutput' + summary: 新建 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}: + delete: + description: 删除 + operationId: inter_vpc_network_CustomizeDelete + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_CustomizeDeleteOutput' + summary: 删除 + tags: + - inter_vpc_network + get: + description: 获取详情 + operationId: inter_vpc_network_FetchCustomizeColumns + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - inter_vpc_network + put: + description: 更新 + operationId: inter_vpc_network_ValidateUpdateData + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_ValidateUpdateDataOutput' + summary: 更新 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/addvpc: + post: + description: 执行操作Addvpc + operationId: inter_vpc_network_PerformAddvpc + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkAddVpcInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformAddvpcOutput' + summary: 执行操作Addvpc + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: inter_vpc_network_PerformChangeOwner + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: inter_vpc_network_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: inter_vpc_network_GetDetailsClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - inter_vpc_network + post: + description: 执行操作ClassMetadata + operationId: inter_vpc_network_PerformClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/disable: + post: + description: 执行操作Disable + operationId: inter_vpc_network_PerformDisable + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformDisableOutput' + summary: 禁用资源 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/enable: + post: + description: 执行操作Enable + operationId: inter_vpc_network_PerformEnable + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformEnableOutput' + summary: 启用资源 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: inter_vpc_network_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/private: + post: + description: 执行操作Private + operationId: inter_vpc_network_PerformPrivate + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformPrivateOutput' + summary: 执行操作Private + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/public: + post: + description: 执行操作Public + operationId: inter_vpc_network_PerformPublic + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformPublicOutput' + summary: 执行操作Public + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/removevpc: + post: + description: 执行操作Removevpc + operationId: inter_vpc_network_PerformRemovevpc + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkRemoveVpcInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformRemovevpcOutput' + summary: 执行操作Removevpc + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: inter_vpc_network_PerformSetClassMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: inter_vpc_network_PerformSetUserMetadata + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/status: + get: + description: 获取指定信息Status + operationId: inter_vpc_network_GetDetailsStatus + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - inter_vpc_network + post: + description: 执行操作Status + operationId: inter_vpc_network_PerformStatus + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformStatusOutput' + summary: 更新资源状态 + tags: + - inter_vpc_network + /inter_vpc_networks/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: inter_vpc_network_PerformSyncstatus + parameters: + - description: The Id or Name of inter_vpc_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - inter_vpc_network + /inter_vpc_networks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: inter_vpc_network_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - inter_vpc_network + /inter_vpc_networks/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: inter_vpc_network_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - inter_vpc_network + /inter_vpc_networks/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: inter_vpc_network_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - inter_vpc_network + /inter_vpc_networks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: inter_vpc_network_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/inter_vpc_network_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - inter_vpc_network + /inter_vpc_networks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: inter_vpc_network_GetPropertySplitable + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - inter_vpc_network + /inter_vpc_networks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: inter_vpc_network_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - inter_vpc_network + /inter_vpc_networks/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: inter_vpc_network_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - inter_vpc_network + /inter_vpc_networks/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: inter_vpc_network_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - inter_vpc_network + /inter_vpc_networks/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: inter_vpc_network_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/inter_vpc_network_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - inter_vpc_network + /ipv6_gateways: + get: + description: 列表 + operationId: ipv6_gateway_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/ipv6_gateway_ListItemFilterOutput' + summary: IPv6网关列表 + tags: + - ipv6_gateway + post: + description: 新建 + operationId: ipv6_gateway_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_ValidateCreateDataOutput' + summary: 新建 + tags: + - ipv6_gateway + /ipv6_gateways/{id}: + delete: + description: 删除 + operationId: ipv6_gateway_CustomizeDelete + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_CustomizeDeleteOutput' + summary: 删除 + tags: + - ipv6_gateway + get: + description: 获取详情 + operationId: ipv6_gateway_FetchCustomizeColumns + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - ipv6_gateway + put: + description: 更新 + operationId: ipv6_gateway_ValidateUpdateData + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_ValidateUpdateDataOutput' + summary: 更新 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: ipv6_gateway_PerformCancelDelete + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - ipv6_gateway + /ipv6_gateways/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: ipv6_gateway_PerformChangeOwner + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - ipv6_gateway + /ipv6_gateways/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: ipv6_gateway_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - ipv6_gateway + /ipv6_gateways/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: ipv6_gateway_GetDetailsClassMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - ipv6_gateway + post: + description: 执行操作ClassMetadata + operationId: ipv6_gateway_PerformClassMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/freeze: + post: + description: 执行操作Freeze + operationId: ipv6_gateway_PerformFreeze + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - ipv6_gateway + /ipv6_gateways/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: ipv6_gateway_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - ipv6_gateway + /ipv6_gateways/{id}/private: + post: + description: 执行操作Private + operationId: ipv6_gateway_PerformPrivate + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformPrivateOutput' + summary: 执行操作Private + tags: + - ipv6_gateway + /ipv6_gateways/{id}/public: + post: + description: 执行操作Public + operationId: ipv6_gateway_PerformPublic + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformPublicOutput' + summary: 执行操作Public + tags: + - ipv6_gateway + /ipv6_gateways/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: ipv6_gateway_PerformSetClassMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: ipv6_gateway_PerformSetUserMetadata + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/status: + get: + description: 获取指定信息Status + operationId: ipv6_gateway_GetDetailsStatus + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - ipv6_gateway + post: + description: 执行操作Status + operationId: ipv6_gateway_PerformStatus + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformStatusOutput' + summary: 更新资源状态 + tags: + - ipv6_gateway + /ipv6_gateways/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: ipv6_gateway_PerformUnfreeze + parameters: + - description: The Id or Name of ipv6_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - ipv6_gateway + /ipv6_gateways/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: ipv6_gateway_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - ipv6_gateway + /ipv6_gateways/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: ipv6_gateway_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - ipv6_gateway + /ipv6_gateways/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: ipv6_gateway_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - ipv6_gateway + /ipv6_gateways/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: ipv6_gateway_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - ipv6_gateway + /ipv6_gateways/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: ipv6_gateway_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - ipv6_gateway + /ipv6_gateways/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: ipv6_gateway_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/ipv6_gateway_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - ipv6_gateway + /ipv6_gateways/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: ipv6_gateway_GetPropertySplitable + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - ipv6_gateway + /ipv6_gateways/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: ipv6_gateway_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - ipv6_gateway + /ipv6_gateways/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: ipv6_gateway_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - ipv6_gateway + /ipv6_gateways/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: ipv6_gateway_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - ipv6_gateway + /ipv6_gateways/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: ipv6_gateway_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/ipv6_gateway_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - ipv6_gateway + /isolated_device_models: + get: + description: 列表 + operationId: isolated_device_model_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 设备类型 + example: NPU + in: query + items: + type: string + name: dev_type + type: array + x-go-name: DevType + - description: 设备型号 + in: query + items: + type: string + name: model + type: array + x-go-name: Model + - description: 设备VendorId + in: query + name: vendor_id + type: string + x-go-name: VendorId + - description: 设备DeviceId + in: query + name: device_id + type: string + x-go-name: DeviceId + - description: 支持热插拔 HotPluggable + in: query + name: hot_pluggable + type: boolean + x-go-name: HotPluggable + responses: + "200": + $ref: '#/responses/isolated_device_model_ListItemFilterOutput' + summary: 列表 + tags: + - isolated_device_model + post: + description: 新建 + operationId: isolated_device_model_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + isolated_device_model: + $ref: '#/definitions/IsolatedDeviceModelCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_ValidateCreateDataOutput' + summary: 新建 + tags: + - isolated_device_model + /isolated_device_models/{id}: + delete: + description: 删除 + operationId: isolated_device_model_CustomizeDelete + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_CustomizeDeleteOutput' + summary: 删除 + tags: + - isolated_device_model + get: + description: 获取详情 + operationId: isolated_device_model_FetchCustomizeColumns + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - isolated_device_model + put: + description: 更新 + operationId: isolated_device_model_ValidateUpdateData + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + $ref: '#/definitions/IsolatedDeviceModelUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_ValidateUpdateDataOutput' + summary: 更新 + tags: + - isolated_device_model + /isolated_device_models/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: isolated_device_model_GetDetailsClassMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - isolated_device_model + post: + description: 执行操作ClassMetadata + operationId: isolated_device_model_PerformClassMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - isolated_device_model + /isolated_device_models/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: isolated_device_model_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_model_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - isolated_device_model + /isolated_device_models/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: isolated_device_model_PerformSetClassMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - isolated_device_model + /isolated_device_models/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: isolated_device_model_PerformSetUserMetadata + parameters: + - description: The Id or Name of isolated_device_model + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - isolated_device_model + /isolated_device_models/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: isolated_device_model_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - isolated_device_model + /isolated_device_models/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: isolated_device_model_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + isolated_device_model: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_model_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - isolated_device_model + /isolated_device_models/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: isolated_device_model_GetPropertySplitable + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - isolated_device_model + /isolated_device_models/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: isolated_device_model_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - isolated_device_model + /isolated_device_models/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: isolated_device_model_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - isolated_device_model + /isolated_device_models/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: isolated_device_model_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/isolated_device_model_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - isolated_device_model + /isolated_devices: + get: + description: 列表 + operationId: isolated_device_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 只列出GPU直通设备 + in: query + name: gpu + type: boolean + x-go-name: Gpu + - description: 只列出USB直通设备 + in: query + name: usb + type: boolean + x-go-name: Usb + - description: 只列出未使用的直通设备 + in: query + name: unused + type: boolean + x-go-name: Unused + - description: |- + # PCI / GPU-HPC / GPU-VGA / USB / NIC + 设备类型 + in: query + items: + type: string + name: dev_type + type: array + x-go-name: DevType + - description: '# Specific device name read from lspci command, e.g. `Tesla + K40m` ...' + in: query + items: + type: string + name: model + type: array + x-go-name: Model + - description: '# pci address of `Bus:Device.Function` format, or usb bus address + of `bus.addr`' + in: query + items: + type: string + name: addr + type: array + x-go-name: Addr + - description: 设备VENDOE编号 + in: query + items: + type: string + name: vendor_device_id + type: array + x-go-name: VendorDeviceId + - description: 展示物理机的上的设备 + in: query + name: show_baremetal_isolated_devices + type: boolean + x-go-name: ShowBaremetalIsolatedDevices + - description: 列出虚拟机上挂载的设备 + in: query + name: guest_id + type: string + x-go-name: GuestId + responses: + "200": + $ref: '#/responses/isolated_device_ListItemFilterOutput' + summary: 直通设备（GPU等）列表 + tags: + - isolated_device + post: + description: 新建 + operationId: isolated_device_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + isolated_device: + $ref: '#/definitions/IsolatedDeviceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_ValidateCreateDataOutput' + summary: 新建 + tags: + - isolated_device + /isolated_devices/{id}: + delete: + description: 删除 + operationId: isolated_device_CustomizeDelete + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_CustomizeDeleteOutput' + summary: 删除 + tags: + - isolated_device + get: + description: 获取详情 + operationId: isolated_device_FetchCustomizeColumns + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - isolated_device + put: + description: 更新 + operationId: isolated_device_ValidateUpdateData + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolatedDeviceUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_ValidateUpdateDataOutput' + summary: 更新 + tags: + - isolated_device + /isolated_devices/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: isolated_device_GetDetailsClassMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - isolated_device + post: + description: 执行操作ClassMetadata + operationId: isolated_device_PerformClassMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - isolated_device + /isolated_devices/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: isolated_device_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - isolated_device + /isolated_devices/{id}/purge: + post: + description: 执行操作Purge + operationId: isolated_device_PerformPurge + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/isolated_device_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - isolated_device + /isolated_devices/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: isolated_device_PerformSetClassMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - isolated_device + /isolated_devices/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: isolated_device_PerformSetUserMetadata + parameters: + - description: The Id or Name of isolated_device + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - isolated_device + /isolated_devices/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: isolated_device_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - isolated_device + /isolated_devices/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: isolated_device_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + isolated_device: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/isolated_device_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - isolated_device + /isolated_devices/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: isolated_device_GetPropertySplitable + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - isolated_device + /isolated_devices/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: isolated_device_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - isolated_device + /isolated_devices/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: isolated_device_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - isolated_device + /isolated_devices/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: isolated_device_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/isolated_device_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - isolated_device + /kafkas: + get: + description: 列表 + operationId: kafka_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/kafka_ListItemFilterOutput' + summary: Kafka实例列表 + tags: + - kafka + post: + description: 新建 + operationId: kafka_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + kafka: + $ref: '#/definitions/KafkaCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_ValidateCreateDataOutput' + summary: 新建 + tags: + - kafka + /kafkas/{id}: + delete: + description: 删除 + operationId: kafka_CustomizeDelete + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_CustomizeDeleteOutput' + summary: 删除 + tags: + - kafka + get: + description: 获取详情 + operationId: kafka_FetchCustomizeColumns + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - kafka + put: + description: 更新 + operationId: kafka_ValidateUpdateData + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_ValidateUpdateDataOutput' + summary: 更新 + tags: + - kafka + /kafkas/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: kafka_PerformCancelDelete + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - kafka + /kafkas/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: kafka_PerformChangeOwner + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - kafka + /kafkas/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: kafka_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - kafka + /kafkas/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: kafka_GetDetailsClassMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - kafka + post: + description: 执行操作ClassMetadata + operationId: kafka_PerformClassMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - kafka + /kafkas/{id}/freeze: + post: + description: 执行操作Freeze + operationId: kafka_PerformFreeze + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - kafka + /kafkas/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: kafka_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - kafka + /kafkas/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: kafka_PerformSetClassMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kafka + /kafkas/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: kafka_PerformSetUserMetadata + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - kafka + /kafkas/{id}/status: + get: + description: 获取指定信息Status + operationId: kafka_GetDetailsStatus + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - kafka + post: + description: 执行操作Status + operationId: kafka_PerformStatus + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformStatusOutput' + summary: 更新资源状态 + tags: + - kafka + /kafkas/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: kafka_PerformSyncstatus + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_PerformSyncstatusOutput' + summary: 同步Kafka实例状态 + tags: + - kafka + /kafkas/{id}/topics: + get: + description: 获取指定信息Topics + operationId: kafka_GetDetailsTopics + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kafka_GetDetailsTopicsOutput' + summary: 获取Kafka Topic列表 + tags: + - kafka + /kafkas/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: kafka_PerformUnfreeze + parameters: + - description: The Id or Name of kafka + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - kafka + /kafkas/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: kafka_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/kafka_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - kafka + /kafkas/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: kafka_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/kafka_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - kafka + /kafkas/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: kafka_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/kafka_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - kafka + /kafkas/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: kafka_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/kafka_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - kafka + /kafkas/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: kafka_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/kafka_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - kafka + /kafkas/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: kafka_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + kafka: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kafka_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - kafka + /kafkas/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: kafka_GetPropertySplitable + responses: + "200": + $ref: '#/responses/kafka_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - kafka + /kafkas/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: kafka_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/kafka_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - kafka + /kafkas/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: kafka_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/kafka_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - kafka + /kafkas/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: kafka_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/kafka_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - kafka + /kafkas/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: kafka_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/kafka_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - kafka + /keypairs: + get: + description: 列表 + operationId: keypair_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 查询指定的用户（ID或名称）拥有的资源 + in: query + name: user_id + type: string + x-go-name: UserId + - description: 加密类型 + example: RSA + in: query + items: + type: string + name: scheme + type: array + x-go-name: Scheme + - description: 指纹信息 + example: 1d:3a:83:4a:a1:f3:75:97:ec:d1:ef:f8:3f:a7:5d:9e + in: query + items: + type: string + name: fingerprint + type: array + x-go-name: Fingerprint + responses: + "200": + $ref: '#/responses/keypair_ListItemFilterOutput' + summary: 列出ssh密钥对 + tags: + - keypair + post: + description: 新建 + operationId: keypair_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + keypair: + $ref: '#/definitions/KeypairCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_ValidateCreateDataOutput' + summary: 新建 + tags: + - keypair + /keypairs/{id}: + delete: + description: 删除 + operationId: keypair_CustomizeDelete + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_CustomizeDeleteOutput' + summary: 删除 + tags: + - keypair + get: + description: 获取详情 + operationId: keypair_FetchCustomizeColumns + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - keypair + put: + description: 更新 + operationId: keypair_ValidateUpdateData + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_ValidateUpdateDataOutput' + summary: 更新 + tags: + - keypair + /keypairs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: keypair_GetDetailsClassMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - keypair + post: + description: 执行操作ClassMetadata + operationId: keypair_PerformClassMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - keypair + /keypairs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: keypair_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - keypair + /keypairs/{id}/privatekey: + get: + description: 获取指定信息Privatekey + operationId: keypair_GetDetailsPrivatekey + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/keypair_GetDetailsPrivatekeyOutput' + summary: 获取指定信息Privatekey + tags: + - keypair + /keypairs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: keypair_PerformSetClassMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - keypair + /keypairs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: keypair_PerformSetUserMetadata + parameters: + - description: The Id or Name of keypair + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - keypair + /keypairs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: keypair_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/keypair_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - keypair + /keypairs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: keypair_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + keypair: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/keypair_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - keypair + /keypairs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: keypair_GetPropertySplitable + responses: + "200": + $ref: '#/responses/keypair_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - keypair + /keypairs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: keypair_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/keypair_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - keypair + /keypairs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: keypair_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/keypair_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - keypair + /keypairs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: keypair_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/keypair_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - keypair + /kube_clusters: + get: + description: 列表 + operationId: kube_cluster_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/kube_cluster_ListItemFilterOutput' + summary: 列出Kube Cluster + tags: + - kube_cluster + post: + description: 新建 + operationId: kube_cluster_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + kube_cluster: + $ref: '#/definitions/KubeClusterCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_ValidateCreateDataOutput' + summary: 新建 + tags: + - kube_cluster + /kube_clusters/{id}: + delete: + description: 删除 + operationId: kube_cluster_CustomizeDelete + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_CustomizeDeleteOutput' + summary: 删除 + tags: + - kube_cluster + get: + description: 获取详情 + operationId: kube_cluster_FetchCustomizeColumns + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - kube_cluster + put: + description: 更新 + operationId: kube_cluster_ValidateUpdateData + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_ValidateUpdateDataOutput' + summary: 更新 + tags: + - kube_cluster + /kube_clusters/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: kube_cluster_PerformChangeOwner + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - kube_cluster + /kube_clusters/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: kube_cluster_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - kube_cluster + /kube_clusters/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: kube_cluster_GetDetailsClassMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - kube_cluster + post: + description: 执行操作ClassMetadata + operationId: kube_cluster_PerformClassMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - kube_cluster + /kube_clusters/{id}/disable: + post: + description: 执行操作Disable + operationId: kube_cluster_PerformDisable + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformDisableOutput' + summary: 禁用资源 + tags: + - kube_cluster + /kube_clusters/{id}/enable: + post: + description: 执行操作Enable + operationId: kube_cluster_PerformEnable + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformEnableOutput' + summary: 启用资源 + tags: + - kube_cluster + /kube_clusters/{id}/kubeconfig: + get: + description: 获取指定信息Kubeconfig + operationId: kube_cluster_GetDetailsKubeconfig + parameters: + - description: 是否获取内网kubeconfig, 默认false即获取外网kubeconfig + in: query + name: private + type: boolean + x-go-name: Private + - description: |- + kubeconfig 到期时间 + 阿里云: 15（15分钟）～4320（3天） + 腾讯云不传此参数默认时效是20年 + format: int64 + in: query + name: expire_minutes + type: integer + x-go-name: ExpireMinutes + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsKubeconfigOutput' + summary: 获取指定信息Kubeconfig + tags: + - kube_cluster + /kube_clusters/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: kube_cluster_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - kube_cluster + /kube_clusters/{id}/private: + post: + description: 执行操作Private + operationId: kube_cluster_PerformPrivate + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformPrivateOutput' + summary: 执行操作Private + tags: + - kube_cluster + /kube_clusters/{id}/public: + post: + description: 执行操作Public + operationId: kube_cluster_PerformPublic + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformPublicOutput' + summary: 执行操作Public + tags: + - kube_cluster + /kube_clusters/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: kube_cluster_PerformSetClassMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_cluster + /kube_clusters/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: kube_cluster_PerformSetUserMetadata + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - kube_cluster + /kube_clusters/{id}/status: + get: + description: 获取指定信息Status + operationId: kube_cluster_GetDetailsStatus + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_cluster_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - kube_cluster + post: + description: 执行操作Status + operationId: kube_cluster_PerformStatus + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformStatusOutput' + summary: 更新资源状态 + tags: + - kube_cluster + /kube_clusters/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: kube_cluster_PerformSyncstatus + parameters: + - description: The Id or Name of kube_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/SyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformSyncstatusOutput' + summary: 同步Kube Cluster状态 + tags: + - kube_cluster + /kube_clusters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: kube_cluster_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - kube_cluster + /kube_clusters/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: kube_cluster_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - kube_cluster + /kube_clusters/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: kube_cluster_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - kube_cluster + /kube_clusters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: kube_cluster_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + kube_cluster: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_cluster_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - kube_cluster + /kube_clusters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: kube_cluster_GetPropertySplitable + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - kube_cluster + /kube_clusters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: kube_cluster_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - kube_cluster + /kube_clusters/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: kube_cluster_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - kube_cluster + /kube_clusters/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: kube_cluster_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - kube_cluster + /kube_clusters/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: kube_cluster_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/kube_cluster_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - kube_cluster + /kube_node_pools: + get: + description: 列表 + operationId: kube_node_pool_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: cloud_kube_cluster_id + type: string + x-go-name: CloudKubeClusterId + responses: + "200": + $ref: '#/responses/kube_node_pool_ListItemFilterOutput' + summary: Kube Node Pool列表 + tags: + - kube_node_pool + post: + description: 新建 + operationId: kube_node_pool_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + kube_node_pool: + $ref: '#/definitions/KubeNodePoolCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_ValidateCreateDataOutput' + summary: 新建 + tags: + - kube_node_pool + /kube_node_pools/{id}: + delete: + description: 删除 + operationId: kube_node_pool_CustomizeDelete + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_CustomizeDeleteOutput' + summary: 删除 + tags: + - kube_node_pool + get: + description: 获取详情 + operationId: kube_node_pool_FetchCustomizeColumns + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - kube_node_pool + put: + description: 更新 + operationId: kube_node_pool_ValidateUpdateData + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_ValidateUpdateDataOutput' + summary: 更新 + tags: + - kube_node_pool + /kube_node_pools/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: kube_node_pool_GetDetailsClassMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - kube_node_pool + post: + description: 执行操作ClassMetadata + operationId: kube_node_pool_PerformClassMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - kube_node_pool + /kube_node_pools/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: kube_node_pool_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - kube_node_pool + /kube_node_pools/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: kube_node_pool_PerformSetClassMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_node_pool + /kube_node_pools/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: kube_node_pool_PerformSetUserMetadata + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - kube_node_pool + /kube_node_pools/{id}/status: + get: + description: 获取指定信息Status + operationId: kube_node_pool_GetDetailsStatus + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_pool_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - kube_node_pool + post: + description: 执行操作Status + operationId: kube_node_pool_PerformStatus + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformStatusOutput' + summary: 更新资源状态 + tags: + - kube_node_pool + /kube_node_pools/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: kube_node_pool_PerformSyncstatus + parameters: + - description: The Id or Name of kube_node_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node_pool: + $ref: '#/definitions/SyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformSyncstatusOutput' + summary: 同步Kube Node Pool 状态 + tags: + - kube_node_pool + /kube_node_pools/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: kube_node_pool_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - kube_node_pool + /kube_node_pools/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: kube_node_pool_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + kube_node_pool: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_pool_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - kube_node_pool + /kube_node_pools/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: kube_node_pool_GetPropertySplitable + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - kube_node_pool + /kube_node_pools/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: kube_node_pool_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - kube_node_pool + /kube_node_pools/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: kube_node_pool_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - kube_node_pool + /kube_node_pools/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: kube_node_pool_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - kube_node_pool + /kube_node_pools/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: kube_node_pool_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/kube_node_pool_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - kube_node_pool + /kube_nodes: + get: + description: 列表 + operationId: kube_node_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/kube_node_ListItemFilterOutput' + summary: Kube Node列表 + tags: + - kube_node + post: + description: 新建 + operationId: kube_node_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + kube_node: + $ref: '#/definitions/KubeNodeCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_ValidateCreateDataOutput' + summary: 新建 + tags: + - kube_node + /kube_nodes/{id}: + delete: + description: 删除 + operationId: kube_node_CustomizeDelete + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_CustomizeDeleteOutput' + summary: 删除 + tags: + - kube_node + get: + description: 获取详情 + operationId: kube_node_FetchCustomizeColumns + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - kube_node + put: + description: 更新 + operationId: kube_node_ValidateUpdateData + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_ValidateUpdateDataOutput' + summary: 更新 + tags: + - kube_node + /kube_nodes/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: kube_node_GetDetailsClassMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - kube_node + post: + description: 执行操作ClassMetadata + operationId: kube_node_PerformClassMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - kube_node + /kube_nodes/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: kube_node_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - kube_node + /kube_nodes/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: kube_node_PerformSetClassMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - kube_node + /kube_nodes/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: kube_node_PerformSetUserMetadata + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - kube_node + /kube_nodes/{id}/status: + get: + description: 获取指定信息Status + operationId: kube_node_GetDetailsStatus + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/kube_node_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - kube_node + post: + description: 执行操作Status + operationId: kube_node_PerformStatus + parameters: + - description: The Id or Name of kube_node + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + kube_node: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformStatusOutput' + summary: 更新资源状态 + tags: + - kube_node + /kube_nodes/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: kube_node_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/kube_node_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - kube_node + /kube_nodes/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: kube_node_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + kube_node: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/kube_node_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - kube_node + /kube_nodes/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: kube_node_GetPropertySplitable + responses: + "200": + $ref: '#/responses/kube_node_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - kube_node + /kube_nodes/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: kube_node_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/kube_node_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - kube_node + /kube_nodes/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: kube_node_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/kube_node_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - kube_node + /kube_nodes/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: kube_node_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/kube_node_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - kube_node + /kube_nodes/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: kube_node_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/kube_node_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - kube_node + /loadbalancer_acls: + get: + description: 列表 + operationId: loadbalancer_acl_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: fingerprint + type: string + x-go-name: Fingerprint + responses: + "200": + $ref: '#/responses/loadbalancer_acl_ListItemFilterOutput' + summary: 负载均衡ACL规则列表 + tags: + - loadbalancer_acl + post: + description: 新建 + operationId: loadbalancer_acl_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}: + delete: + description: 删除 + operationId: loadbalancer_acl_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_acl + get: + description: 获取详情 + operationId: loadbalancer_acl_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_acl + put: + description: 更新 + operationId: loadbalancer_acl_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: loadbalancer_acl_PerformCancelDelete + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: loadbalancer_acl_PerformChangeOwner + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: loadbalancer_acl_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_acl_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_acl + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_acl_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/freeze: + post: + description: 执行操作Freeze + operationId: loadbalancer_acl_PerformFreeze + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_acl_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/patch: + post: + description: This is intended mainly for command line operations. + operationId: loadbalancer_acl_PerformPatch + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclPatchInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPatchOutput' + summary: PerformPatch patches acl entries by adding then deleting the specified + acls. + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/private: + post: + description: 执行操作Private + operationId: loadbalancer_acl_PerformPrivate + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPrivateOutput' + summary: 执行操作Private + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/public: + post: + description: 执行操作Public + operationId: loadbalancer_acl_PerformPublic + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPublicOutput' + summary: 执行操作Public + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_acl_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_acl_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_acl_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_acl_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_acl + post: + description: 执行操作Status + operationId: loadbalancer_acl_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_acl + /loadbalancer_acls/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: loadbalancer_acl_PerformUnfreeze + parameters: + - description: The Id or Name of loadbalancer_acl + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - loadbalancer_acl + /loadbalancer_acls/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_acl_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_acl + /loadbalancer_acls/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: loadbalancer_acl_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - loadbalancer_acl + /loadbalancer_acls/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: loadbalancer_acl_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - loadbalancer_acl + /loadbalancer_acls/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: loadbalancer_acl_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - loadbalancer_acl + /loadbalancer_acls/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: loadbalancer_acl_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - loadbalancer_acl + /loadbalancer_acls/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_acl_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_acl_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_acl + /loadbalancer_acls/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_acl_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_acl + /loadbalancer_acls/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_acl_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_acl + /loadbalancer_acls/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_acl_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_acl + /loadbalancer_acls/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_acl_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_acl + /loadbalancer_acls/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_acl_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_acl_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_acl + /loadbalancer_agents: + get: + description: 列表 + operationId: loadbalancer_agent_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 负载均衡集群ID或名称 + in: query + name: cluster_id + type: string + x-go-name: ClusterId + - description: 以负载均衡集群排序 + in: query + name: order_by_cluster + type: string + x-go-name: OrderByCluster + - in: query + items: + type: string + name: version + type: array + x-go-name: Version + - in: query + items: + type: string + name: ip + type: array + x-go-name: IP + - in: query + items: + type: string + name: ha_state + type: array + x-go-name: HaState + responses: + "200": + $ref: '#/responses/loadbalancer_agent_ListItemFilterOutput' + summary: 负载均衡Agent列表 + tags: + - loadbalancer_agent + post: + description: 新建 + operationId: loadbalancer_agent_ValidateCreateData + responses: + "200": + $ref: '#/responses/loadbalancer_agent_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}: + delete: + description: 删除 + operationId: loadbalancer_agent_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_agent + get: + description: 获取详情 + operationId: loadbalancer_agent_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_agent + put: + description: 更新 + operationId: loadbalancer_agent_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_agent_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_agent + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_agent_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/deploy: + post: + description: 执行操作Deploy + operationId: loadbalancer_agent_PerformDeploy + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDeployInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformDeployOutput' + summary: 执行操作Deploy + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/hb: + post: + description: 执行操作Hb + operationId: loadbalancer_agent_PerformHb + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformHbOutput' + summary: 执行操作Hb + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/join-cluster: + post: + description: 执行操作JoinCluster + operationId: loadbalancer_agent_PerformJoinCluster + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentJoinClusterInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformJoinClusterOutput' + summary: 执行操作JoinCluster + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/leave-cluster: + post: + description: 执行操作LeaveCluster + operationId: loadbalancer_agent_PerformLeaveCluster + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentLeaveClusterInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformLeaveClusterOutput' + summary: 执行操作LeaveCluster + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_agent_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/params-patch: + post: + description: 执行操作ParamsPatch + operationId: loadbalancer_agent_PerformParamsPatch + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformParamsPatchOutput' + summary: 执行操作ParamsPatch + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_agent_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_agent_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_agent + /loadbalancer_agents/{id}/undeploy: + post: + description: 执行操作Undeploy + operationId: loadbalancer_agent_PerformUndeploy + parameters: + - description: The Id or Name of loadbalancer_agent + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformUndeployOutput' + summary: 执行操作Undeploy + tags: + - loadbalancer_agent + /loadbalancer_agents/default-params: + get: + description: 获取指定资源类的信息DefaultParams + operationId: loadbalancer_agent_GetPropertyDefaultParams + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertyDefaultParamsOutput' + summary: 获取指定资源类的信息DefaultParams + tags: + - loadbalancer_agent + /loadbalancer_agents/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_agent_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_agent + /loadbalancer_agents/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_agent_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_agent_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_agent + /loadbalancer_agents/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_agent_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_agent + /loadbalancer_agents/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_agent_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_agent + /loadbalancer_agents/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_agent_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_agent + /loadbalancer_agents/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_agent_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_agent_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_agent + /loadbalancer_backend_groups: + get: + description: 列表 + operationId: loadbalancer_backend_group_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: filter LoadbalancerBackendGroup with no reference + in: query + name: no_ref + type: boolean + x-go-name: NoRef + - in: query + items: + type: string + name: type + type: array + x-go-name: Type + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_ListItemFilterOutput' + summary: 负载均衡后端服务器组列表 + tags: + - loadbalancer_backend_group + post: + description: 新建 + operationId: loadbalancer_backend_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}: + delete: + description: 删除 + operationId: loadbalancer_backend_group_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_backend_group + get: + description: 获取详情 + operationId: loadbalancer_backend_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_backend_group + put: + description: 更新 + operationId: loadbalancer_backend_group_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_backend_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_backend_group + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_backend_group_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_backend_group_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_backend_group_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_backend_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_backend_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_backend_group_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_backend_group + post: + description: 执行操作Status + operationId: loadbalancer_backend_group_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_backend_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_backend_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_backend_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_backend_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_backend_group_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_backend_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_backend_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_backend_group + /loadbalancer_backend_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_backend_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_backend_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_backend_group + /loadbalancer_backends: + get: + description: 列表 + operationId: loadbalancer_backend_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: 负载均衡后端组ID或名称 + in: query + name: backend_group_id + type: string + x-go-name: BackendGroupId + - description: 以负载均衡后端组名称排序 + in: query + name: order_by_backend_group + type: string + x-go-name: OrderByBackendGroup + - description: filter by backend server + in: query + name: backend + type: string + x-go-name: Backend + - in: query + items: + type: string + name: backend_type + type: array + x-go-name: BackendType + - in: query + items: + type: string + name: backend_role + type: array + x-go-name: BackendRole + - in: query + items: + type: string + name: address + type: array + x-go-name: Address + - in: query + items: + type: string + name: send_proxy + type: array + x-go-name: SendProxy + - in: query + items: + type: string + name: ssl + type: array + x-go-name: Ssl + responses: + "200": + $ref: '#/responses/loadbalancer_backend_ListItemFilterOutput' + summary: 负载均衡后端列表 + tags: + - loadbalancer_backend + post: + description: 新建 + operationId: loadbalancer_backend_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}: + delete: + description: 删除 + operationId: loadbalancer_backend_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_backend + get: + description: 获取详情 + operationId: loadbalancer_backend_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_backend + put: + description: 更新 + operationId: loadbalancer_backend_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_backend_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_backend + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_backend_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_backend_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_backend_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_backend_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_backend_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_backend + /loadbalancer_backends/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_backend_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_backend + post: + description: 执行操作Status + operationId: loadbalancer_backend_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_backend + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_backend + /loadbalancer_backends/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_backend_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_backend + /loadbalancer_backends/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_backend_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_backend_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_backend + /loadbalancer_backends/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_backend_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_backend + /loadbalancer_backends/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_backend_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_backend + /loadbalancer_backends/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_backend_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_backend + /loadbalancer_backends/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_backend_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_backend + /loadbalancer_backends/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_backend_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_backend_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_backend + /loadbalancer_certificates: + get: + description: 列表 + operationId: loadbalancer_certificate_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + items: + type: string + name: common_name + type: array + x-go-name: CommonName + - in: query + items: + type: string + name: subject_alternative_names + type: array + x-go-name: SubjectAlternativeNames + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_ListItemFilterOutput' + summary: 列表 + tags: + - loadbalancer_certificate + post: + description: 新建 + operationId: loadbalancer_certificate_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}: + delete: + description: 删除 + operationId: loadbalancer_certificate_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_certificate + get: + description: 获取详情 + operationId: loadbalancer_certificate_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_certificate + put: + description: 更新 + operationId: loadbalancer_certificate_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: loadbalancer_certificate_PerformCancelDelete + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: loadbalancer_certificate_PerformChangeOwner + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_certificate_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_certificate + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_certificate_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/freeze: + post: + description: 执行操作Freeze + operationId: loadbalancer_certificate_PerformFreeze + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_certificate_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/private: + post: + description: 执行操作Private + operationId: loadbalancer_certificate_PerformPrivate + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformPrivateOutput' + summary: 执行操作Private + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/public: + post: + description: 执行操作Public + operationId: loadbalancer_certificate_PerformPublic + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformPublicOutput' + summary: 执行操作Public + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_certificate_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_certificate_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_certificate_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_certificate + post: + description: 执行操作Status + operationId: loadbalancer_certificate_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_certificate + /loadbalancer_certificates/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: loadbalancer_certificate_PerformUnfreeze + parameters: + - description: The Id or Name of loadbalancer_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - loadbalancer_certificate + /loadbalancer_certificates/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_certificate_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_certificate + /loadbalancer_certificates/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: loadbalancer_certificate_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - loadbalancer_certificate + /loadbalancer_certificates/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: loadbalancer_certificate_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - loadbalancer_certificate + /loadbalancer_certificates/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: loadbalancer_certificate_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - loadbalancer_certificate + /loadbalancer_certificates/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: loadbalancer_certificate_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - loadbalancer_certificate + /loadbalancer_certificates/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_certificate_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_certificate + /loadbalancer_certificates/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_certificate_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_certificate + /loadbalancer_certificates/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_certificate_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_certificate + /loadbalancer_certificates/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_certificate_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_certificate + /loadbalancer_certificates/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_certificate_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_certificate + /loadbalancer_certificates/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_certificate_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_certificate_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_certificate + /loadbalancer_clusters: + get: + description: 列表 + operationId: loadbalancer_cluster_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_ListItemFilterOutput' + summary: 负载均衡集群列表 + tags: + - loadbalancer_cluster + post: + description: 新建 + operationId: loadbalancer_cluster_ValidateCreateData + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}: + delete: + description: 删除 + operationId: loadbalancer_cluster_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_cluster + get: + description: 获取详情 + operationId: loadbalancer_cluster_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_cluster + put: + description: 更新 + operationId: loadbalancer_cluster_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_cluster_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_cluster + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_cluster_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_cluster_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/params-patch: + post: + description: 执行操作ParamsPatch + operationId: loadbalancer_cluster_PerformParamsPatch + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformParamsPatchOutput' + summary: 执行操作ParamsPatch + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_cluster_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_cluster_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_cluster + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_cluster + /loadbalancer_clusters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_cluster_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_cluster + /loadbalancer_clusters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_cluster_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_cluster + /loadbalancer_clusters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_cluster_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_cluster + /loadbalancer_clusters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_cluster_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_cluster + /loadbalancer_clusters/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_cluster_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_cluster + /loadbalancer_clusters/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_cluster_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_cluster_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_cluster + /loadbalancer_listener_rules: + get: + description: 列表 + operationId: loadbalancer_listener_rule_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: 负载均衡监听器 + in: query + name: listener_id + type: string + x-go-name: ListenerId + - description: 以负载均衡监听器名称排序 + in: query + name: order_by_listener + type: string + x-go-name: OrderByListener + - description: filter by backend_group + in: query + name: backend_group + type: string + x-go-name: BackendGroup + - description: 默认转发策略，目前只有aws用到其它云都是false + in: query + name: is_default + type: boolean + x-go-name: IsDefault + - in: query + items: + type: string + name: domain + type: array + x-go-name: Domain + - in: query + items: + type: string + name: path + type: array + x-go-name: Path + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_ListItemFilterOutput' + summary: 负载均衡监听器规则列表 + tags: + - loadbalancer_listener_rule + post: + description: 新建 + operationId: loadbalancer_listener_rule_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}: + delete: + description: 删除 + operationId: loadbalancer_listener_rule_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_listener_rule + get: + description: 获取详情 + operationId: loadbalancer_listener_rule_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_listener_rule + put: + description: 更新 + operationId: loadbalancer_listener_rule_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/backend-status: + get: + description: 获取指定信息BackendStatus + operationId: loadbalancer_listener_rule_GetDetailsBackendStatus + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsBackendStatusOutput' + summary: 获取指定信息BackendStatus + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_listener_rule_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_listener_rule + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_listener_rule_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_listener_rule_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_listener_rule_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_listener_rule_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_listener_rule_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_listener_rule_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_listener_rule + post: + description: 执行操作Status + operationId: loadbalancer_listener_rule_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_listener_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformStatusOutput' + summary: 更新资源状态 + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_listener_rule_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_listener_rule_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_listener_rule_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_listener_rule_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_listener_rule_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_listener_rule_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_listener_rule + /loadbalancer_listener_rules/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_listener_rule_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_listener_rule_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_listener_rule + /loadbalancer_listeners: + get: + description: 列表 + operationId: loadbalancer_listener_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: ACL名称或ID + in: query + name: acl_id + type: string + x-go-name: AclId + - description: filter by backend_group + in: query + name: backend_group + type: string + x-go-name: BackendGroup + - in: query + items: + type: string + name: listener_type + type: array + x-go-name: ListenerType + - in: query + items: + format: int64 + type: integer + name: listener_port + type: array + x-go-name: ListenerPort + - in: query + items: + type: string + name: scheduler + type: array + x-go-name: Scheduler + - in: query + items: + type: string + name: certificate_id + type: array + x-go-name: Certificate + - in: query + items: + type: string + name: send_proxy + type: array + x-go-name: SendProxy + - in: query + items: + type: string + name: acl_status + type: array + x-go-name: AclStatus + - in: query + items: + type: string + name: acl_type + type: array + x-go-name: AclType + responses: + "200": + $ref: '#/responses/loadbalancer_listener_ListItemFilterOutput' + summary: 负载均衡监听器Listener列表 + tags: + - loadbalancer_listener + post: + description: 新建 + operationId: loadbalancer_listener_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}: + delete: + description: 删除 + operationId: loadbalancer_listener_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer_listener + get: + description: 获取详情 + operationId: loadbalancer_listener_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer_listener + put: + description: 更新 + operationId: loadbalancer_listener_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/backend-status: + get: + description: 获取指定信息BackendStatus + operationId: loadbalancer_listener_GetDetailsBackendStatus + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsBackendStatusOutput' + summary: 获取指定信息BackendStatus + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_listener_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer_listener + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_listener_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_listener_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_listener_PerformPurge + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_listener_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_listener_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_listener_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer_listener + post: + description: 执行操作Status + operationId: loadbalancer_listener_PerformStatus + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformStatusOutput' + summary: 执行操作Status + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/sync: + post: + description: 执行操作Sync + operationId: loadbalancer_listener_PerformSync + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSyncOutput' + summary: 执行操作Sync + tags: + - loadbalancer_listener + /loadbalancer_listeners/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: loadbalancer_listener_PerformSyncstatus + parameters: + - description: The Id or Name of loadbalancer_listener + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - loadbalancer_listener + /loadbalancer_listeners/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_listener_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer_listener + /loadbalancer_listeners/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_listener_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_listener_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer_listener + /loadbalancer_listeners/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_listener_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer_listener + /loadbalancer_listeners/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_listener_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer_listener + /loadbalancer_listeners/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_listener_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer_listener + /loadbalancer_listeners/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_listener_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer_listener + /loadbalancer_listeners/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_listener_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_listener_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer_listener + /loadbalancers: + get: + description: 列表 + operationId: loadbalancer_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: filter by cluster + in: query + name: cluster + type: string + x-go-name: Cluster + - in: query + items: + type: string + name: address + type: array + x-go-name: Address + - description: 地址类型 + in: query + items: + type: string + name: address_type + type: array + x-go-name: AddressType + - description: 网络类型 + in: query + items: + type: string + name: network_type + type: array + x-go-name: NetworkType + - description: 计费类型 + in: query + items: + type: string + name: charge_type + type: array + x-go-name: ChargeType + - description: 套餐名称 + in: query + items: + type: string + name: loadbalancer_spec + type: array + x-go-name: LoadbalancerSpec + - description: filter for EIP + in: query + name: with_eip + type: boolean + x-go-name: WithEip + - in: query + name: without_eip + type: boolean + x-go-name: WithoutEip + - in: query + name: eip_associable + type: boolean + x-go-name: EipAssociable + - in: query + name: usable_loadbalancer_for_eip + type: string + x-go-name: UsableLoadbalancerForEip + responses: + "200": + $ref: '#/responses/loadbalancer_ListItemFilterOutput' + summary: 负载均衡实例列表 + tags: + - loadbalancer + post: + description: 新建 + operationId: loadbalancer_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + loadbalancer: + $ref: '#/definitions/LoadbalancerCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_ValidateCreateDataOutput' + summary: 新建 + tags: + - loadbalancer + /loadbalancers/{id}: + delete: + description: 删除 + operationId: loadbalancer_CustomizeDelete + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_CustomizeDeleteOutput' + summary: 删除 + tags: + - loadbalancer + get: + description: 获取详情 + operationId: loadbalancer_FetchCustomizeColumns + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - loadbalancer + put: + description: 更新 + operationId: loadbalancer_ValidateUpdateData + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_ValidateUpdateDataOutput' + summary: 更新 + tags: + - loadbalancer + /loadbalancers/{id}/associate-eip: + post: + description: 执行操作AssociateEip + operationId: loadbalancer_PerformAssociateEip + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerAssociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformAssociateEipOutput' + summary: 绑定弹性公网IP, 仅支持kvm + tags: + - loadbalancer + /loadbalancers/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: loadbalancer_PerformCancelDelete + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - loadbalancer + /loadbalancers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: loadbalancer_PerformChangeOwner + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - loadbalancer + /loadbalancers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: loadbalancer_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - loadbalancer + /loadbalancers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: loadbalancer_GetDetailsClassMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - loadbalancer + post: + description: 执行操作ClassMetadata + operationId: loadbalancer_PerformClassMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - loadbalancer + /loadbalancers/{id}/create-eip: + post: + description: 执行操作CreateEip + operationId: loadbalancer_PerformCreateEip + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerCreateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformCreateEipOutput' + summary: 执行操作CreateEip + tags: + - loadbalancer + /loadbalancers/{id}/dissociate-eip: + post: + description: 执行操作DissociateEip + operationId: loadbalancer_PerformDissociateEip + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDissociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformDissociateEipOutput' + summary: 解绑弹性公网IP，仅支持kvm + tags: + - loadbalancer + /loadbalancers/{id}/freeze: + post: + description: 执行操作Freeze + operationId: loadbalancer_PerformFreeze + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - loadbalancer + /loadbalancers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: loadbalancer_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - loadbalancer + /loadbalancers/{id}/purge: + post: + description: 执行操作Purge + operationId: loadbalancer_PerformPurge + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - loadbalancer + /loadbalancers/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: loadbalancer_PerformRemoteUpdate + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - loadbalancer + /loadbalancers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: loadbalancer_PerformSetClassMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - loadbalancer + /loadbalancers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: loadbalancer_PerformSetUserMetadata + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - loadbalancer + /loadbalancers/{id}/status: + get: + description: 获取指定信息Status + operationId: loadbalancer_GetDetailsStatus + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - loadbalancer + post: + description: 执行操作Status + operationId: loadbalancer_PerformStatus + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformStatusOutput' + summary: 执行操作Status + tags: + - loadbalancer + /loadbalancers/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: loadbalancer_PerformSyncstatus + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/loadbalancer_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - loadbalancer + /loadbalancers/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: loadbalancer_PerformUnfreeze + parameters: + - description: The Id or Name of loadbalancer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - loadbalancer + /loadbalancers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: loadbalancer_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - loadbalancer + /loadbalancers/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: loadbalancer_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - loadbalancer + /loadbalancers/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: loadbalancer_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - loadbalancer + /loadbalancers/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: loadbalancer_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - loadbalancer + /loadbalancers/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: loadbalancer_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - loadbalancer + /loadbalancers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: loadbalancer_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + loadbalancer: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/loadbalancer_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - loadbalancer + /loadbalancers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: loadbalancer_GetPropertySplitable + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - loadbalancer + /loadbalancers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: loadbalancer_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - loadbalancer + /loadbalancers/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: loadbalancer_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - loadbalancer + /loadbalancers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: loadbalancer_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - loadbalancer + /loadbalancers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: loadbalancer_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/loadbalancer_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - loadbalancer + /misc_resources: + get: + description: 列表 + operationId: misc_resource_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/misc_resource_ListItemFilterOutput' + summary: 列出Misc Resource + tags: + - misc_resource + post: + description: 新建 + operationId: misc_resource_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + misc_resource: + $ref: '#/definitions/MiscResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_ValidateCreateDataOutput' + summary: 新建 + tags: + - misc_resource + /misc_resources/{id}: + delete: + description: 删除 + operationId: misc_resource_CustomizeDelete + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_CustomizeDeleteOutput' + summary: 删除 + tags: + - misc_resource + get: + description: 获取详情 + operationId: misc_resource_FetchCustomizeColumns + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - misc_resource + put: + description: 更新 + operationId: misc_resource_ValidateUpdateData + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_ValidateUpdateDataOutput' + summary: 更新 + tags: + - misc_resource + /misc_resources/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: misc_resource_PerformCancelDelete + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - misc_resource + /misc_resources/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: misc_resource_PerformChangeOwner + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - misc_resource + /misc_resources/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: misc_resource_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - misc_resource + /misc_resources/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: misc_resource_GetDetailsClassMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - misc_resource + post: + description: 执行操作ClassMetadata + operationId: misc_resource_PerformClassMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - misc_resource + /misc_resources/{id}/freeze: + post: + description: 执行操作Freeze + operationId: misc_resource_PerformFreeze + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - misc_resource + /misc_resources/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: misc_resource_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - misc_resource + /misc_resources/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: misc_resource_PerformSetClassMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - misc_resource + /misc_resources/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: misc_resource_PerformSetUserMetadata + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - misc_resource + /misc_resources/{id}/status: + get: + description: 获取指定信息Status + operationId: misc_resource_GetDetailsStatus + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/misc_resource_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - misc_resource + post: + description: 执行操作Status + operationId: misc_resource_PerformStatus + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformStatusOutput' + summary: 更新资源状态 + tags: + - misc_resource + /misc_resources/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: misc_resource_PerformUnfreeze + parameters: + - description: The Id or Name of misc_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - misc_resource + /misc_resources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: misc_resource_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - misc_resource + /misc_resources/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: misc_resource_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - misc_resource + /misc_resources/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: misc_resource_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - misc_resource + /misc_resources/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: misc_resource_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - misc_resource + /misc_resources/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: misc_resource_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - misc_resource + /misc_resources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: misc_resource_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + misc_resource: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/misc_resource_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - misc_resource + /misc_resources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: misc_resource_GetPropertySplitable + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - misc_resource + /misc_resources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: misc_resource_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - misc_resource + /misc_resources/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: misc_resource_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - misc_resource + /misc_resources/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: misc_resource_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - misc_resource + /misc_resources/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: misc_resource_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/misc_resource_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - misc_resource + /modelarts_pool_skus: + get: + description: 列表 + operationId: modelarts_pool_sku_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: ProcessorType + type: string + - in: query + name: CpuArch + type: string + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_ListItemFilterOutput' + summary: 列表 + tags: + - modelarts_pool_sku + post: + description: 新建 + operationId: modelarts_pool_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + modelarts_pool_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}: + delete: + description: 删除 + operationId: modelarts_pool_sku_CustomizeDelete + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - modelarts_pool_sku + get: + description: 获取详情 + operationId: modelarts_pool_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - modelarts_pool_sku + put: + description: 更新 + operationId: modelarts_pool_sku_ValidateUpdateData + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: modelarts_pool_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - modelarts_pool_sku + post: + description: 执行操作ClassMetadata + operationId: modelarts_pool_sku_PerformClassMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: modelarts_pool_sku_PerformDisable + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: modelarts_pool_sku_PerformEnable + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: modelarts_pool_sku_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: modelarts_pool_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: modelarts_pool_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: modelarts_pool_sku_GetDetailsStatus + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - modelarts_pool_sku + post: + description: 执行操作Status + operationId: modelarts_pool_sku_PerformStatus + parameters: + - description: The Id or Name of modelarts_pool_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - modelarts_pool_sku + /modelarts_pool_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: modelarts_pool_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - modelarts_pool_sku + /modelarts_pool_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: modelarts_pool_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - modelarts_pool_sku + /modelarts_pool_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: modelarts_pool_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - modelarts_pool_sku + /modelarts_pool_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: modelarts_pool_sku_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - modelarts_pool_sku + /modelarts_pool_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: modelarts_pool_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - modelarts_pool_sku + /modelarts_pool_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: modelarts_pool_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - modelarts_pool_sku + /modelarts_pool_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: modelarts_pool_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/modelarts_pool_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - modelarts_pool_sku + /modelarts_pools: + get: + description: 列表 + operationId: modelarts_pool_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + responses: + "200": + $ref: '#/responses/modelarts_pool_ListItemFilterOutput' + summary: Pool实例列表 + tags: + - modelarts_pool + post: + description: 新建 + operationId: modelarts_pool_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + modelarts_pool: + $ref: '#/definitions/ModelartsPoolCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_ValidateCreateDataOutput' + summary: 新建 + tags: + - modelarts_pool + /modelarts_pools/{id}: + delete: + description: 删除 + operationId: modelarts_pool_CustomizeDelete + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_CustomizeDeleteOutput' + summary: 进入删除任务 + tags: + - modelarts_pool + get: + description: 获取详情 + operationId: modelarts_pool_FetchCustomizeColumns + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - modelarts_pool + put: + description: 更新 + operationId: modelarts_pool_ValidateUpdateData + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_ValidateUpdateDataOutput' + summary: 更新 + tags: + - modelarts_pool + /modelarts_pools/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: modelarts_pool_PerformCancelDelete + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - modelarts_pool + /modelarts_pools/{id}/change-config: + post: + description: 执行操作ChangeConfig + operationId: modelarts_pool_PerformChangeConfig + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolChangeConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformChangeConfigOutput' + summary: 执行操作ChangeConfig + tags: + - modelarts_pool + /modelarts_pools/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: modelarts_pool_PerformChangeOwner + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - modelarts_pool + /modelarts_pools/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: modelarts_pool_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - modelarts_pool + /modelarts_pools/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: modelarts_pool_GetDetailsClassMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - modelarts_pool + post: + description: 执行操作ClassMetadata + operationId: modelarts_pool_PerformClassMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - modelarts_pool + /modelarts_pools/{id}/freeze: + post: + description: 执行操作Freeze + operationId: modelarts_pool_PerformFreeze + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - modelarts_pool + /modelarts_pools/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: modelarts_pool_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - modelarts_pool + /modelarts_pools/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: modelarts_pool_PerformSetClassMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - modelarts_pool + /modelarts_pools/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: modelarts_pool_PerformSetUserMetadata + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - modelarts_pool + /modelarts_pools/{id}/status: + get: + description: 获取指定信息Status + operationId: modelarts_pool_GetDetailsStatus + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/modelarts_pool_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - modelarts_pool + post: + description: 执行操作Status + operationId: modelarts_pool_PerformStatus + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformStatusOutput' + summary: 更新资源状态 + tags: + - modelarts_pool + /modelarts_pools/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: modelarts_pool_PerformSyncstatus + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - modelarts_pool + /modelarts_pools/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: modelarts_pool_PerformUnfreeze + parameters: + - description: The Id or Name of modelarts_pool + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - modelarts_pool + /modelarts_pools/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: modelarts_pool_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - modelarts_pool + /modelarts_pools/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: modelarts_pool_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - modelarts_pool + /modelarts_pools/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: modelarts_pool_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - modelarts_pool + /modelarts_pools/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: modelarts_pool_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - modelarts_pool + /modelarts_pools/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: modelarts_pool_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - modelarts_pool + /modelarts_pools/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: modelarts_pool_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + modelarts_pool: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/modelarts_pool_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - modelarts_pool + /modelarts_pools/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: modelarts_pool_GetPropertySplitable + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - modelarts_pool + /modelarts_pools/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: modelarts_pool_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - modelarts_pool + /modelarts_pools/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: modelarts_pool_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - modelarts_pool + /modelarts_pools/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: modelarts_pool_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - modelarts_pool + /modelarts_pools/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: modelarts_pool_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/modelarts_pool_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - modelarts_pool + /mongo_dbs: + get: + description: 列表 + operationId: mongo_db_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - format: int64 + in: query + name: vcpu_count + type: integer + x-go-name: VcpuCount + - format: int64 + in: query + name: vmem_size_mb + type: integer + x-go-name: VmemSizeMb + - in: query + name: category + type: string + x-go-name: Category + - in: query + name: engine + type: string + x-go-name: Engine + - in: query + name: engine_version + type: string + x-go-name: EngineVersion + - in: query + name: instance_type + type: string + x-go-name: InstanceType + responses: + "200": + $ref: '#/responses/mongo_db_ListItemFilterOutput' + summary: MongoDB实例列表 + tags: + - mongo_db + post: + description: 新建 + operationId: mongo_db_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + mongo_db: + $ref: '#/definitions/MongoDBCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_ValidateCreateDataOutput' + summary: 新建 + tags: + - mongo_db + /mongo_dbs/{id}: + delete: + description: 删除 + operationId: mongo_db_CustomizeDelete + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_CustomizeDeleteOutput' + summary: 删除 + tags: + - mongo_db + get: + description: 获取详情 + operationId: mongo_db_FetchCustomizeColumns + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - mongo_db + put: + description: 更新 + operationId: mongo_db_ValidateUpdateData + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_ValidateUpdateDataOutput' + summary: 更新 + tags: + - mongo_db + /mongo_dbs/{id}/backups: + get: + description: 获取指定信息Backups + operationId: mongo_db_GetDetailsBackups + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsBackupsOutput' + summary: 获取备份列表 + tags: + - mongo_db + /mongo_dbs/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: mongo_db_PerformCancelDelete + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - mongo_db + /mongo_dbs/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: mongo_db_PerformCancelExpire + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - mongo_db + /mongo_dbs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: mongo_db_PerformChangeOwner + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - mongo_db + /mongo_dbs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: mongo_db_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - mongo_db + /mongo_dbs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: mongo_db_GetDetailsClassMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - mongo_db + post: + description: 执行操作ClassMetadata + operationId: mongo_db_PerformClassMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - mongo_db + /mongo_dbs/{id}/freeze: + post: + description: 执行操作Freeze + operationId: mongo_db_PerformFreeze + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - mongo_db + /mongo_dbs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: mongo_db_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - mongo_db + /mongo_dbs/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: mongo_db_PerformPostpaidExpire + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - mongo_db + /mongo_dbs/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: mongo_db_PerformRemoteUpdate + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - mongo_db + /mongo_dbs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: mongo_db_PerformSetClassMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - mongo_db + /mongo_dbs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: mongo_db_PerformSetUserMetadata + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - mongo_db + /mongo_dbs/{id}/status: + get: + description: 获取指定信息Status + operationId: mongo_db_GetDetailsStatus + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - mongo_db + post: + description: 执行操作Status + operationId: mongo_db_PerformStatus + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformStatusOutput' + summary: 更新资源状态 + tags: + - mongo_db + /mongo_dbs/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: mongo_db_PerformSyncstatus + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mongo_db_PerformSyncstatusOutput' + summary: 同步MongoDB实例状态 + tags: + - mongo_db + /mongo_dbs/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: mongo_db_PerformUnfreeze + parameters: + - description: The Id or Name of mongo_db + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - mongo_db + /mongo_dbs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: mongo_db_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - mongo_db + /mongo_dbs/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: mongo_db_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - mongo_db + /mongo_dbs/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: mongo_db_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - mongo_db + /mongo_dbs/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: mongo_db_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - mongo_db + /mongo_dbs/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: mongo_db_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - mongo_db + /mongo_dbs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: mongo_db_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + mongo_db: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mongo_db_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - mongo_db + /mongo_dbs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: mongo_db_GetPropertySplitable + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - mongo_db + /mongo_dbs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: mongo_db_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - mongo_db + /mongo_dbs/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: mongo_db_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - mongo_db + /mongo_dbs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: mongo_db_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - mongo_db + /mongo_dbs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: mongo_db_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/mongo_db_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - mongo_db + /mount_targets: + get: + description: 列表 + operationId: mount_target_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 权限组Id + in: query + name: access_group_id + type: string + x-go-name: AccessGroupId + - description: 以权限组排序 + in: query + name: order_by_access_group + type: string + x-go-name: OrderByAccessGroup + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: 文件系统Id + in: query + name: file_system_id + type: string + x-go-name: FileSystemId + responses: + "200": + $ref: '#/responses/mount_target_ListItemFilterOutput' + summary: 列表 + tags: + - mount_target + post: + description: 新建 + operationId: mount_target_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + mount_target: + $ref: '#/definitions/MountTargetCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_ValidateCreateDataOutput' + summary: 新建 + tags: + - mount_target + /mount_targets/{id}: + delete: + description: 删除 + operationId: mount_target_CustomizeDelete + parameters: + - default: false + description: 是否越过回收站直接删除 + in: query + name: OverridePendingDelete + type: boolean + - default: false + description: 是否仅删除本地资源 + in: query + name: Purge + type: boolean + - default: false + description: 是否删除快照 + in: query + name: DeleteSnapshots + type: boolean + - default: false + description: 是否删除关联的EIP + in: query + name: DeleteEip + type: boolean + - default: false + description: 是否删除关联的数据盘 + in: query + name: DeleteDisks + type: boolean + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/NatgatewayDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_CustomizeDeleteOutput' + summary: 删除挂载点 + tags: + - mount_target + get: + description: 获取详情 + operationId: mount_target_FetchCustomizeColumns + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - mount_target + put: + description: 更新 + operationId: mount_target_ValidateUpdateData + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_ValidateUpdateDataOutput' + summary: 更新 + tags: + - mount_target + /mount_targets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: mount_target_GetDetailsClassMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - mount_target + post: + description: 执行操作ClassMetadata + operationId: mount_target_PerformClassMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - mount_target + /mount_targets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: mount_target_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - mount_target + /mount_targets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: mount_target_PerformSetClassMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - mount_target + /mount_targets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: mount_target_PerformSetUserMetadata + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - mount_target + /mount_targets/{id}/status: + get: + description: 获取指定信息Status + operationId: mount_target_GetDetailsStatus + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/mount_target_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - mount_target + post: + description: 执行操作Status + operationId: mount_target_PerformStatus + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformStatusOutput' + summary: 更新资源状态 + tags: + - mount_target + /mount_targets/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: mount_target_PerformSyncstatus + parameters: + - description: The Id or Name of mount_target + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformSyncstatusOutput' + summary: 同步挂载点状态 + tags: + - mount_target + /mount_targets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: mount_target_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/mount_target_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - mount_target + /mount_targets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: mount_target_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + mount_target: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/mount_target_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - mount_target + /mount_targets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: mount_target_GetPropertySplitable + responses: + "200": + $ref: '#/responses/mount_target_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - mount_target + /mount_targets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: mount_target_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/mount_target_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - mount_target + /mount_targets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: mount_target_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/mount_target_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - mount_target + /mount_targets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: mount_target_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/mount_target_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - mount_target + /mount_targets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: mount_target_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/mount_target_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - mount_target + /nas_skus: + get: + description: 列表 + operationId: nas_sku_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: postpaid_stauts + type: string + x-go-name: PostpaidStatus + - in: query + name: prepaid_status + type: string + x-go-name: PrepaidStatus + - in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + responses: + "200": + $ref: '#/responses/nas_sku_ListItemFilterOutput' + summary: 列表 + tags: + - nas_sku + post: + description: 新建 + operationId: nas_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nas_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - nas_sku + /nas_skus/{id}: + delete: + description: 删除 + operationId: nas_sku_CustomizeDelete + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - nas_sku + get: + description: 获取详情 + operationId: nas_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nas_sku + put: + description: 更新 + operationId: nas_sku_ValidateUpdateData + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nas_sku + /nas_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nas_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nas_sku + post: + description: 执行操作ClassMetadata + operationId: nas_sku_PerformClassMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nas_sku + /nas_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: nas_sku_PerformDisable + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - nas_sku + /nas_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: nas_sku_PerformEnable + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - nas_sku + /nas_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nas_sku_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nas_sku + /nas_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nas_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nas_sku + /nas_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nas_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nas_sku + /nas_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: nas_sku_GetDetailsStatus + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nas_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nas_sku + post: + description: 执行操作Status + operationId: nas_sku_PerformStatus + parameters: + - description: The Id or Name of nas_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nas_sku + /nas_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nas_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nas_sku + /nas_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nas_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nas_sku + /nas_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nas_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nas_sku + /nas_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nas_sku_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nas_sku + /nas_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nas_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nas_sku + /nas_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: nas_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + nas_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nas_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - nas_sku + /nas_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: nas_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - nas_sku + /nas_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nas_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nas_sku + /nas_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nas_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nas_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nas_sku + /nat_dentries: + get: + description: 列表 + operationId: nat_dentry_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: NAT网关ID or Name + in: query + name: natgateway_id + type: string + x-go-name: NatgatewayId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以NAT网关名字排序 + in: query + name: order_by_natgateway + type: string + x-go-name: OrderByNatgateway + - in: query + items: + type: string + name: external_ip + type: array + x-go-name: ExternalIP + - in: query + items: + format: int64 + type: integer + name: external_port + type: array + x-go-name: ExternalPort + - in: query + items: + type: string + name: internal_ip + type: array + x-go-name: InternalIP + - in: query + items: + format: int64 + type: integer + name: internal_port + type: array + x-go-name: InternalPort + - in: query + items: + type: string + name: ip_protocol + type: array + x-go-name: IpProtocol + responses: + "200": + $ref: '#/responses/nat_dentry_ListItemFilterOutput' + summary: NAT网关的目的地址转换规则列表 + tags: + - nat_dentry + post: + description: 新建 + operationId: nat_dentry_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_dentry: + $ref: '#/definitions/SNatDCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_dentry + /nat_dentries/{id}: + delete: + description: 删除 + operationId: nat_dentry_CustomizeDelete + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_CustomizeDeleteOutput' + summary: 删除 + tags: + - nat_dentry + get: + description: 获取详情 + operationId: nat_dentry_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_dentry + put: + description: 更新 + operationId: nat_dentry_ValidateUpdateData + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_dentry + /nat_dentries/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: nat_dentry_PerformChangeOwner + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - nat_dentry + /nat_dentries/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: nat_dentry_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - nat_dentry + /nat_dentries/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_dentry_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_dentry + post: + description: 执行操作ClassMetadata + operationId: nat_dentry_PerformClassMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_dentry + /nat_dentries/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_dentry_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_dentry + /nat_dentries/{id}/private: + post: + description: 执行操作Private + operationId: nat_dentry_PerformPrivate + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformPrivateOutput' + summary: 执行操作Private + tags: + - nat_dentry + /nat_dentries/{id}/public: + post: + description: 执行操作Public + operationId: nat_dentry_PerformPublic + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformPublicOutput' + summary: 执行操作Public + tags: + - nat_dentry + /nat_dentries/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_dentry_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_dentry + /nat_dentries/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_dentry_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_dentry + /nat_dentries/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_dentry_GetDetailsStatus + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_dentry_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_dentry + post: + description: 执行操作Status + operationId: nat_dentry_PerformStatus + parameters: + - description: The Id or Name of nat_dentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_dentry + /nat_dentries/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_dentry_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_dentry + /nat_dentries/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: nat_dentry_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - nat_dentry + /nat_dentries/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: nat_dentry_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - nat_dentry + /nat_dentries/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_dentry_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_dentry: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_dentry_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_dentry + /nat_dentries/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_dentry_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_dentry + /nat_dentries/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_dentry_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_dentry + /nat_dentries/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_dentry_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_dentry + /nat_dentries/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_dentry_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_dentry + /nat_dentries/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_dentry_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_dentry_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_dentry + /nat_entries: + get: + description: 列表 + operationId: nat_entry_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: NAT网关ID or Name + in: query + name: natgateway_id + type: string + x-go-name: NatgatewayId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以NAT网关名字排序 + in: query + name: order_by_natgateway + type: string + x-go-name: OrderByNatgateway + responses: + "200": + $ref: '#/responses/nat_entry_ListItemFilterOutput' + summary: NAT网关转发规则列表 + tags: + - nat_entry + post: + description: 新建 + operationId: nat_entry_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_entry: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_entry + /nat_entries/{id}: + delete: + description: 删除 + operationId: nat_entry_CustomizeDelete + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_CustomizeDeleteOutput' + summary: 删除 + tags: + - nat_entry + get: + description: 获取详情 + operationId: nat_entry_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_entry + put: + description: 更新 + operationId: nat_entry_ValidateUpdateData + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_entry + /nat_entries/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: nat_entry_PerformChangeOwner + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - nat_entry + /nat_entries/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: nat_entry_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - nat_entry + /nat_entries/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_entry_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_entry + post: + description: 执行操作ClassMetadata + operationId: nat_entry_PerformClassMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_entry + /nat_entries/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_entry_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_entry + /nat_entries/{id}/private: + post: + description: 执行操作Private + operationId: nat_entry_PerformPrivate + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformPrivateOutput' + summary: 执行操作Private + tags: + - nat_entry + /nat_entries/{id}/public: + post: + description: 执行操作Public + operationId: nat_entry_PerformPublic + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformPublicOutput' + summary: 执行操作Public + tags: + - nat_entry + /nat_entries/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_entry_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_entry + /nat_entries/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_entry_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_entry + /nat_entries/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_entry_GetDetailsStatus + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_entry_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_entry + post: + description: 执行操作Status + operationId: nat_entry_PerformStatus + parameters: + - description: The Id or Name of nat_entry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_entry + /nat_entries/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_entry_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_entry + /nat_entries/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: nat_entry_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - nat_entry + /nat_entries/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: nat_entry_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - nat_entry + /nat_entries/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_entry_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_entry: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_entry_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_entry + /nat_entries/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_entry_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_entry + /nat_entries/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_entry_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_entry + /nat_entries/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_entry_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_entry + /nat_entries/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_entry_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_entry + /nat_entries/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_entry_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_entry_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_entry + /nat_gateways: + get: + description: 列表 + operationId: nat_gateway_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/nat_gateway_ListItemFilterOutput' + summary: NAT网关列表 + tags: + - nat_gateway + post: + description: 新建 + operationId: nat_gateway_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_gateway: + $ref: '#/definitions/NatgatewayCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_gateway + /nat_gateways/{id}: + delete: + description: 删除 + operationId: nat_gateway_CustomizeDelete + parameters: + - default: false + description: 是否越过回收站直接删除 + in: query + name: OverridePendingDelete + type: boolean + - default: false + description: 是否仅删除本地资源 + in: query + name: Purge + type: boolean + - default: false + description: 是否删除快照 + in: query + name: DeleteSnapshots + type: boolean + - default: false + description: 是否删除关联的EIP + in: query + name: DeleteEip + type: boolean + - default: false + description: 是否删除关联的数据盘 + in: query + name: DeleteDisks + type: boolean + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDeleteInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_CustomizeDeleteOutput' + summary: 删除NAT + tags: + - nat_gateway + get: + description: 获取详情 + operationId: nat_gateway_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_gateway + put: + description: 更新 + operationId: nat_gateway_ValidateUpdateData + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_gateway + /nat_gateways/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: nat_gateway_PerformCancelExpire + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - nat_gateway + /nat_gateways/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: nat_gateway_PerformChangeOwner + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - nat_gateway + /nat_gateways/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: nat_gateway_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - nat_gateway + /nat_gateways/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_gateway_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_gateway + post: + description: 执行操作ClassMetadata + operationId: nat_gateway_PerformClassMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_gateway + /nat_gateways/{id}/dnat-resources: + post: + description: 执行操作DnatResources + operationId: nat_gateway_PerformDnatResources + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_PerformDnatResourcesOutput' + summary: 执行操作DnatResources + tags: + - nat_gateway + /nat_gateways/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_gateway_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_gateway + /nat_gateways/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: nat_gateway_PerformPostpaidExpire + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - nat_gateway + /nat_gateways/{id}/private: + post: + description: 执行操作Private + operationId: nat_gateway_PerformPrivate + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformPrivateOutput' + summary: 执行操作Private + tags: + - nat_gateway + /nat_gateways/{id}/public: + post: + description: 执行操作Public + operationId: nat_gateway_PerformPublic + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformPublicOutput' + summary: 执行操作Public + tags: + - nat_gateway + /nat_gateways/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: nat_gateway_PerformRemoteUpdate + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - nat_gateway + /nat_gateways/{id}/renew: + post: + description: 执行操作Renew + operationId: nat_gateway_PerformRenew + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/RenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformRenewOutput' + summary: 执行操作Renew + tags: + - nat_gateway + /nat_gateways/{id}/set-auto-renew: + post: + description: |- + 要求NAT状态为available + 要求NAT计费类型为包年包月(预付费) + operationId: nat_gateway_PerformSetAutoRenew + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/AutoRenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSetAutoRenewOutput' + summary: 设置自动续费 + tags: + - nat_gateway + /nat_gateways/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_gateway_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_gateway + /nat_gateways/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_gateway_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_gateway + /nat_gateways/{id}/snat-resources: + post: + description: 执行操作SnatResources + operationId: nat_gateway_PerformSnatResources + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSnatResourcesOutput' + summary: 执行操作SnatResources + tags: + - nat_gateway + /nat_gateways/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_gateway_GetDetailsStatus + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_gateway_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_gateway + post: + description: 执行操作Status + operationId: nat_gateway_PerformStatus + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_gateway + /nat_gateways/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: nat_gateway_PerformSyncstatus + parameters: + - description: The Id or Name of nat_gateway + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatGatewaySyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformSyncstatusOutput' + summary: 同步NAT网关状态 + tags: + - nat_gateway + /nat_gateways/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_gateway_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_gateway + /nat_gateways/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: nat_gateway_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - nat_gateway + /nat_gateways/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: nat_gateway_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - nat_gateway + /nat_gateways/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_gateway_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_gateway: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_gateway_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_gateway + /nat_gateways/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_gateway_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_gateway + /nat_gateways/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_gateway_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_gateway + /nat_gateways/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_gateway_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_gateway + /nat_gateways/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_gateway_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_gateway + /nat_gateways/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_gateway_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_gateway_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_gateway + /nat_sentries: + get: + description: 列表 + operationId: nat_sentry_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: NAT网关ID or Name + in: query + name: natgateway_id + type: string + x-go-name: NatgatewayId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以NAT网关名字排序 + in: query + name: order_by_natgateway + type: string + x-go-name: OrderByNatgateway + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - in: query + items: + type: string + name: ip + type: array + x-go-name: IP + - in: query + items: + type: string + name: source_cidr + type: array + x-go-name: SourceCIDR + responses: + "200": + $ref: '#/responses/nat_sentry_ListItemFilterOutput' + summary: NAT网关的源地址转换规则列表 + tags: + - nat_sentry + post: + description: 新建 + operationId: nat_sentry_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_sentry: + $ref: '#/definitions/SNatSCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_sentry + /nat_sentries/{id}: + delete: + description: 删除 + operationId: nat_sentry_CustomizeDelete + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_CustomizeDeleteOutput' + summary: 删除 + tags: + - nat_sentry + get: + description: 获取详情 + operationId: nat_sentry_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_sentry + put: + description: 更新 + operationId: nat_sentry_ValidateUpdateData + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_sentry + /nat_sentries/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: nat_sentry_PerformChangeOwner + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - nat_sentry + /nat_sentries/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: nat_sentry_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - nat_sentry + /nat_sentries/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_sentry_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_sentry + post: + description: 执行操作ClassMetadata + operationId: nat_sentry_PerformClassMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_sentry + /nat_sentries/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_sentry_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_sentry + /nat_sentries/{id}/private: + post: + description: 执行操作Private + operationId: nat_sentry_PerformPrivate + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformPrivateOutput' + summary: 执行操作Private + tags: + - nat_sentry + /nat_sentries/{id}/public: + post: + description: 执行操作Public + operationId: nat_sentry_PerformPublic + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformPublicOutput' + summary: 执行操作Public + tags: + - nat_sentry + /nat_sentries/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_sentry_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_sentry + /nat_sentries/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_sentry_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_sentry + /nat_sentries/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_sentry_GetDetailsStatus + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sentry_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_sentry + post: + description: 执行操作Status + operationId: nat_sentry_PerformStatus + parameters: + - description: The Id or Name of nat_sentry + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_sentry + /nat_sentries/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_sentry_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_sentry + /nat_sentries/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: nat_sentry_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - nat_sentry + /nat_sentries/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: nat_sentry_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - nat_sentry + /nat_sentries/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_sentry_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_sentry: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sentry_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_sentry + /nat_sentries/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_sentry_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_sentry + /nat_sentries/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_sentry_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_sentry + /nat_sentries/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_sentry_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_sentry + /nat_sentries/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_sentry_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_sentry + /nat_sentries/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_sentry_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_sentry_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_sentry + /nat_skus: + get: + description: 列表 + operationId: nat_sku_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - in: query + name: postpaid_stauts + type: string + x-go-name: PostpaidStatus + - in: query + name: prepaid_status + type: string + x-go-name: PrepaidStatus + - in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + responses: + "200": + $ref: '#/responses/nat_sku_ListItemFilterOutput' + summary: 列表 + tags: + - nat_sku + post: + description: 新建 + operationId: nat_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + nat_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - nat_sku + /nat_skus/{id}: + delete: + description: 删除 + operationId: nat_sku_CustomizeDelete + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - nat_sku + get: + description: 获取详情 + operationId: nat_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - nat_sku + put: + description: 更新 + operationId: nat_sku_ValidateUpdateData + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - nat_sku + /nat_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: nat_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - nat_sku + post: + description: 执行操作ClassMetadata + operationId: nat_sku_PerformClassMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - nat_sku + /nat_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: nat_sku_PerformDisable + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - nat_sku + /nat_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: nat_sku_PerformEnable + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - nat_sku + /nat_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: nat_sku_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - nat_sku + /nat_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: nat_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - nat_sku + /nat_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: nat_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - nat_sku + /nat_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: nat_sku_GetDetailsStatus + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/nat_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - nat_sku + post: + description: 执行操作Status + operationId: nat_sku_PerformStatus + parameters: + - description: The Id or Name of nat_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - nat_sku + /nat_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: nat_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - nat_sku + /nat_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: nat_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - nat_sku + /nat_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: nat_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - nat_sku + /nat_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: nat_sku_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - nat_sku + /nat_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: nat_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - nat_sku + /nat_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: nat_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + nat_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/nat_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - nat_sku + /nat_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: nat_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - nat_sku + /nat_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: nat_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - nat_sku + /nat_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: nat_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/nat_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - nat_sku + /net_tap_flows: + get: + description: 列表 + operationId: net_tap_flow_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - in: query + name: tap_id + type: string + x-go-name: TapId + - in: query + name: host_id + type: string + x-go-name: HostId + responses: + "200": + $ref: '#/responses/net_tap_flow_ListItemFilterOutput' + summary: 列表 + tags: + - net_tap_flow + post: + description: 新建 + operationId: net_tap_flow_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + net_tap_flow: + $ref: '#/definitions/NetTapFlowCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_ValidateCreateDataOutput' + summary: 新建 + tags: + - net_tap_flow + /net_tap_flows/{id}: + delete: + description: 删除 + operationId: net_tap_flow_CustomizeDelete + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_CustomizeDeleteOutput' + summary: 删除 + tags: + - net_tap_flow + get: + description: 获取详情 + operationId: net_tap_flow_FetchCustomizeColumns + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - net_tap_flow + put: + description: 更新 + operationId: net_tap_flow_ValidateUpdateData + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_ValidateUpdateDataOutput' + summary: 更新 + tags: + - net_tap_flow + /net_tap_flows/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: net_tap_flow_GetDetailsClassMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - net_tap_flow + post: + description: 执行操作ClassMetadata + operationId: net_tap_flow_PerformClassMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - net_tap_flow + /net_tap_flows/{id}/disable: + post: + description: 执行操作Disable + operationId: net_tap_flow_PerformDisable + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformDisableOutput' + summary: 禁用资源 + tags: + - net_tap_flow + /net_tap_flows/{id}/enable: + post: + description: 执行操作Enable + operationId: net_tap_flow_PerformEnable + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformEnableOutput' + summary: 启用资源 + tags: + - net_tap_flow + /net_tap_flows/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: net_tap_flow_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - net_tap_flow + /net_tap_flows/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: net_tap_flow_PerformSetClassMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - net_tap_flow + /net_tap_flows/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: net_tap_flow_PerformSetUserMetadata + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - net_tap_flow + /net_tap_flows/{id}/status: + get: + description: 获取指定信息Status + operationId: net_tap_flow_GetDetailsStatus + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_flow_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - net_tap_flow + post: + description: 执行操作Status + operationId: net_tap_flow_PerformStatus + parameters: + - description: The Id or Name of net_tap_flow + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformStatusOutput' + summary: 更新资源状态 + tags: + - net_tap_flow + /net_tap_flows/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: net_tap_flow_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - net_tap_flow + /net_tap_flows/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: net_tap_flow_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + net_tap_flow: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_flow_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - net_tap_flow + /net_tap_flows/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: net_tap_flow_GetPropertySplitable + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - net_tap_flow + /net_tap_flows/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: net_tap_flow_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - net_tap_flow + /net_tap_flows/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: net_tap_flow_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - net_tap_flow + /net_tap_flows/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: net_tap_flow_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - net_tap_flow + /net_tap_flows/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: net_tap_flow_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/net_tap_flow_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - net_tap_flow + /net_tap_services: + get: + description: 列表 + operationId: net_tap_service_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - in: query + name: host_id + type: string + x-go-name: HostId + - description: 按目的ip地址排序 + in: query + name: order_by_ip + pattern: asc|desc + type: string + x-go-name: OrderByIp + - description: 按镜像源数量排序 + in: query + name: order_by_flow_count + pattern: asc|desc + type: string + x-go-name: OrderByFlowCount + responses: + "200": + $ref: '#/responses/net_tap_service_ListItemFilterOutput' + summary: 列表 + tags: + - net_tap_service + post: + description: 新建 + operationId: net_tap_service_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + net_tap_service: + $ref: '#/definitions/NetTapServiceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_ValidateCreateDataOutput' + summary: 新建 + tags: + - net_tap_service + /net_tap_services/{id}: + delete: + description: 删除 + operationId: net_tap_service_CustomizeDelete + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_CustomizeDeleteOutput' + summary: 删除 + tags: + - net_tap_service + get: + description: 获取详情 + operationId: net_tap_service_FetchCustomizeColumns + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - net_tap_service + put: + description: 更新 + operationId: net_tap_service_ValidateUpdateData + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/EnabledStatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_ValidateUpdateDataOutput' + summary: 更新 + tags: + - net_tap_service + /net_tap_services/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: net_tap_service_GetDetailsClassMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - net_tap_service + post: + description: 执行操作ClassMetadata + operationId: net_tap_service_PerformClassMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - net_tap_service + /net_tap_services/{id}/disable: + post: + description: 执行操作Disable + operationId: net_tap_service_PerformDisable + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformDisableOutput' + summary: 执行操作Disable + tags: + - net_tap_service + /net_tap_services/{id}/enable: + post: + description: 执行操作Enable + operationId: net_tap_service_PerformEnable + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformEnableOutput' + summary: 执行操作Enable + tags: + - net_tap_service + /net_tap_services/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: net_tap_service_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - net_tap_service + /net_tap_services/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: net_tap_service_PerformSetClassMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - net_tap_service + /net_tap_services/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: net_tap_service_PerformSetUserMetadata + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - net_tap_service + /net_tap_services/{id}/status: + get: + description: 获取指定信息Status + operationId: net_tap_service_GetDetailsStatus + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/net_tap_service_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - net_tap_service + post: + description: 执行操作Status + operationId: net_tap_service_PerformStatus + parameters: + - description: The Id or Name of net_tap_service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformStatusOutput' + summary: 更新资源状态 + tags: + - net_tap_service + /net_tap_services/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: net_tap_service_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - net_tap_service + /net_tap_services/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: net_tap_service_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + net_tap_service: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/net_tap_service_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - net_tap_service + /net_tap_services/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: net_tap_service_GetPropertySplitable + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - net_tap_service + /net_tap_services/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: net_tap_service_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - net_tap_service + /net_tap_services/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: net_tap_service_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - net_tap_service + /net_tap_services/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: net_tap_service_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - net_tap_service + /net_tap_services/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: net_tap_service_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/net_tap_service_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - net_tap_service + /network_addresses: + get: + description: 列表 + operationId: network_address_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + items: + type: string + name: GuestId + type: array + responses: + "200": + $ref: '#/responses/network_address_ListItemFilterOutput' + summary: 列表 + tags: + - network_address + post: + description: 新建 + operationId: network_address_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network_address: + $ref: '#/definitions/NetworkAddressCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_ValidateCreateDataOutput' + summary: 新建 + tags: + - network_address + /network_addresses/{id}: + delete: + description: 删除 + operationId: network_address_CustomizeDelete + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_CustomizeDeleteOutput' + summary: 删除 + tags: + - network_address + get: + description: 获取详情 + operationId: network_address_FetchCustomizeColumns + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network_address + put: + description: 更新 + operationId: network_address_ValidateUpdateData + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network_address + /network_addresses/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: network_address_GetDetailsClassMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - network_address + post: + description: 执行操作ClassMetadata + operationId: network_address_PerformClassMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - network_address + /network_addresses/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: network_address_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_address_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - network_address + /network_addresses/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: network_address_PerformSetClassMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_address + /network_addresses/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: network_address_PerformSetUserMetadata + parameters: + - description: The Id or Name of network_address + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - network_address + /network_addresses/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_address_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_address_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network_address + /network_addresses/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_address_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network_address: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_address_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network_address + /network_addresses/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_address_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_address_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network_address + /network_addresses/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_address_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/network_address_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network_address + /network_addresses/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: network_address_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/network_address_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - network_address + /network_addresses/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: network_address_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/network_address_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - network_address + /network_interfaces: + get: + description: 列表 + operationId: network_interface_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: MAC地址 + in: query + items: + type: string + name: mac + type: array + x-go-name: Mac + - description: 绑定资源类型 + in: query + items: + type: string + name: associate_type + type: array + x-go-name: AssociateType + - description: 绑定资源Id + in: query + items: + type: string + name: associate_id + type: array + x-go-name: AssociateId + responses: + "200": + $ref: '#/responses/network_interface_ListItemFilterOutput' + summary: 虚拟网卡列表 + tags: + - network_interface + post: + description: 新建 + operationId: network_interface_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network_interface: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_ValidateCreateDataOutput' + summary: 新建 + tags: + - network_interface + /network_interfaces/{id}: + delete: + description: 删除 + operationId: network_interface_CustomizeDelete + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_CustomizeDeleteOutput' + summary: 删除 + tags: + - network_interface + get: + description: 获取详情 + operationId: network_interface_FetchCustomizeColumns + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network_interface + put: + description: 更新 + operationId: network_interface_ValidateUpdateData + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network_interface + /network_interfaces/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: network_interface_PerformChangeOwner + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - network_interface + /network_interfaces/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: network_interface_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - network_interface + /network_interfaces/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: network_interface_GetDetailsClassMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - network_interface + post: + description: 执行操作ClassMetadata + operationId: network_interface_PerformClassMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - network_interface + /network_interfaces/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: network_interface_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - network_interface + /network_interfaces/{id}/private: + post: + description: 执行操作Private + operationId: network_interface_PerformPrivate + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformPrivateOutput' + summary: 执行操作Private + tags: + - network_interface + /network_interfaces/{id}/public: + post: + description: 执行操作Public + operationId: network_interface_PerformPublic + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformPublicOutput' + summary: 执行操作Public + tags: + - network_interface + /network_interfaces/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: network_interface_PerformSetClassMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_interface + /network_interfaces/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: network_interface_PerformSetUserMetadata + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - network_interface + /network_interfaces/{id}/status: + get: + description: 获取指定信息Status + operationId: network_interface_GetDetailsStatus + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_interface_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - network_interface + post: + description: 执行操作Status + operationId: network_interface_PerformStatus + parameters: + - description: The Id or Name of network_interface + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformStatusOutput' + summary: 更新资源状态 + tags: + - network_interface + /network_interfaces/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_interface_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network_interface + /network_interfaces/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: network_interface_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - network_interface + /network_interfaces/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: network_interface_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - network_interface + /network_interfaces/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_interface_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network_interface: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_interface_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network_interface + /network_interfaces/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_interface_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_interface_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network_interface + /network_interfaces/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_interface_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/network_interface_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network_interface + /network_interfaces/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: network_interface_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - network_interface + /network_interfaces/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: network_interface_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - network_interface + /network_interfaces/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: network_interface_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/network_interface_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - network_interface + /network_ip_macs: + get: + description: 列表 + operationId: network_ip_mac_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - in: query + name: network_id + type: string + x-go-name: NetworkId + - in: query + items: + type: string + name: mac_addr + type: array + x-go-name: MacAddr + - in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + responses: + "200": + $ref: '#/responses/network_ip_mac_ListItemFilterOutput' + summary: 列表 + tags: + - network_ip_mac + post: + description: 新建 + operationId: network_ip_mac_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network_ip_mac: + $ref: '#/definitions/NetworkIpMacCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_ValidateCreateDataOutput' + summary: 新建 + tags: + - network_ip_mac + /network_ip_macs/{id}: + delete: + description: 删除 + operationId: network_ip_mac_CustomizeDelete + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_CustomizeDeleteOutput' + summary: 删除 + tags: + - network_ip_mac + get: + description: 获取详情 + operationId: network_ip_mac_FetchCustomizeColumns + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network_ip_mac + put: + description: 更新 + operationId: network_ip_mac_ValidateUpdateData + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network_ip_mac + /network_ip_macs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: network_ip_mac_GetDetailsClassMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - network_ip_mac + post: + description: 执行操作ClassMetadata + operationId: network_ip_mac_PerformClassMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - network_ip_mac + /network_ip_macs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: network_ip_mac_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_ip_mac_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - network_ip_mac + /network_ip_macs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: network_ip_mac_PerformSetClassMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network_ip_mac + /network_ip_macs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: network_ip_mac_PerformSetUserMetadata + parameters: + - description: The Id or Name of network_ip_mac + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - network_ip_mac + /network_ip_macs/batch-create: + post: + description: 执行操作BatchCreate + operationId: network_ip_mac_PerformBatchCreate + parameters: + - in: body + name: body + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacBatchCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformBatchCreateOutput' + summary: 执行操作BatchCreate + tags: + - network_ip_mac + /network_ip_macs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_ip_mac_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network_ip_mac + /network_ip_macs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_ip_mac_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network_ip_mac: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ip_mac_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network_ip_mac + /network_ip_macs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_ip_mac_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network_ip_mac + /network_ip_macs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_ip_mac_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network_ip_mac + /network_ip_macs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: network_ip_mac_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - network_ip_mac + /network_ip_macs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: network_ip_mac_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/network_ip_mac_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - network_ip_mac + /networkinterfacenetworks: + get: + description: 列表 + operationId: networkinterfacenetwork_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_ListItemFilterOutput' + summary: 列表 + tags: + - networkinterfacenetwork + post: + description: 新建 + operationId: networkinterfacenetwork_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + networkinterfacenetwork: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_ValidateCreateDataOutput' + summary: 新建 + tags: + - networkinterfacenetwork + /networkinterfacenetworks/{id}: + delete: + description: 删除 + operationId: networkinterfacenetwork_CustomizeDelete + parameters: + - description: The Id or Name of networkinterfacenetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_CustomizeDeleteOutput' + summary: 删除 + tags: + - networkinterfacenetwork + get: + description: 获取详情 + operationId: networkinterfacenetwork_FetchCustomizeColumns + parameters: + - description: The Id or Name of networkinterfacenetwork + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - networkinterfacenetwork + put: + description: 更新 + operationId: networkinterfacenetwork_ValidateUpdateData + parameters: + - description: The Id or Name of networkinterfacenetwork + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_ValidateUpdateDataOutput' + summary: 更新 + tags: + - networkinterfacenetwork + /networkinterfacenetworks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: networkinterfacenetwork_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - networkinterfacenetwork + /networkinterfacenetworks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: networkinterfacenetwork_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - networkinterfacenetwork + /networkinterfacenetworks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: networkinterfacenetwork_GetPropertySplitable + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - networkinterfacenetwork + /networkinterfacenetworks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: networkinterfacenetwork_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/networkinterfacenetwork_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - networkinterfacenetwork + /networks: + get: + description: 列表 + operationId: network_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by route table which associate with it + in: query + name: route_table_id + type: string + x-go-name: RouteTableId + - description: 'description: Exact matching ip address in network.' + example: 10.168.222.1 + in: query + name: ip + type: string + x-go-name: Ip + - description: 'description: Fuzzy matching ip address in network.' + example: 10.168.222.1 + in: query + name: ip_match + type: string + x-go-name: IpMatch + - in: query + items: + type: string + name: ifname_hint + type: array + x-go-name: IfnameHint + - description: 起始IP地址 + in: query + items: + type: string + name: guest_ip_start + type: array + x-go-name: GuestIpStart + - description: 接收IP地址 + in: query + items: + type: string + name: guest_ip_end + type: array + x-go-name: GuestIpEnd + - description: 掩码 + in: query + items: + format: int8 + type: integer + name: guest_ip_mask + type: array + x-go-name: GuestIpMask + - description: 网关地址 + in: query + name: guest_gateway + type: string + x-go-name: GuestGateway + - description: DNS + in: query + items: + type: string + name: guest_dns + type: array + x-go-name: GuestDns + - description: allow multiple dhcp, seperated by "," + in: query + items: + type: string + name: guest_dhcp + type: array + x-go-name: GuestDhcp + - description: NTP + in: query + items: + type: string + name: guest_ntp + type: array + x-go-name: GuestNtp + - in: query + items: + type: string + name: guest_domain + type: array + x-go-name: GuestDomain + - in: query + items: + type: string + name: guest_ip6_start + type: array + x-go-name: GuestIp6Start + - in: query + items: + type: string + name: guest_ip6_end + type: array + x-go-name: GuestIp6End + - in: query + items: + format: int8 + type: integer + name: guest_ip6_mask + type: array + x-go-name: GuestIp6Mask + - in: query + items: + type: string + name: guest_gateway6 + type: array + x-go-name: GuestGateway6 + - in: query + items: + type: string + name: guest_dns6 + type: array + x-go-name: GuestDns6 + - in: query + items: + type: string + name: guest_domain6 + type: array + x-go-name: GuestDomain6 + - description: vlanId 1~4096 + in: query + items: + format: int64 + type: integer + name: vlan_id + type: array + x-go-name: VlanId + - description: 服务器类型 + example: server + in: query + items: + type: string + name: server_type + type: array + x-go-name: ServerType + - description: 分配策略 + in: query + items: + type: string + name: alloc_policy + type: array + x-go-name: AllocPolicy + - description: 是否加入自动分配地址池 + in: query + name: is_auto_alloc + type: boolean + x-go-name: IsAutoAlloc + - description: 是否为基础网络（underlay） + in: query + name: is_classic + type: boolean + x-go-name: IsClassic + - description: filter by Host schedtag + in: query + name: host_schedtag_id + type: string + x-go-name: HostSchedtagId + - description: filter by BGP types + in: query + items: + type: string + name: bgp_type + type: array + x-go-name: BgpType + - in: query + name: host_type + type: string + x-go-name: HostType + - description: 按起始ip地址排序 + in: query + name: order_by_ip_start + pattern: asc|desc + type: string + x-go-name: OrderByIpStart + - description: 按终止ip地址排序 + in: query + name: order_by_ip_end + pattern: asc|desc + type: string + x-go-name: OrderByIpEnd + responses: + "200": + $ref: '#/responses/network_ListItemFilterOutput' + summary: IP子网列表 + tags: + - network + post: + description: 新建 + operationId: network_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + network: + $ref: '#/definitions/NetworkCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ValidateCreateDataOutput' + summary: 新建 + tags: + - network + /networks/{id}: + delete: + description: 删除 + operationId: network_CustomizeDelete + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_CustomizeDeleteOutput' + summary: 删除 + tags: + - network + get: + description: 获取详情 + operationId: network_FetchCustomizeColumns + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - network + put: + description: 更新 + operationId: network_ValidateUpdateData + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_ValidateUpdateDataOutput' + summary: 更新 + tags: + - network + /networks/{id}/addresses: + get: + description: 获取指定信息Addresses + operationId: network_GetDetailsAddresses + parameters: + - description: 获取资源的范围，例如 project|domain|system + in: query + name: scope + type: string + x-go-name: Scope + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsAddressesOutput' + summary: 获取指定信息Addresses + tags: + - network + /networks/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: network_PerformCancelDelete + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - network + /networks/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: network_PerformChangeOwner + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - network + /networks/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: network_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - network + /networks/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: network_GetDetailsClassMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - network + post: + description: 执行操作ClassMetadata + operationId: network_PerformClassMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - network + /networks/{id}/freeze: + post: + description: 执行操作Freeze + operationId: network_PerformFreeze + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - network + /networks/{id}/merge: + post: + description: 将两个相连的IP子网合并成一个IP子网 + operationId: network_PerformMerge + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkMergeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformMergeOutput' + summary: 合并IP子网 + tags: + - network + /networks/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: network_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - network + /networks/{id}/private: + post: + description: 执行操作Private + operationId: network_PerformPrivate + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformPrivateOutput' + summary: 执行操作Private + tags: + - network + /networks/{id}/public: + post: + description: 执行操作Public + operationId: network_PerformPublic + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformPublicOutput' + summary: 执行操作Public + tags: + - network + /networks/{id}/purge: + post: + description: 要求IP子网内没有被分配IP,若清除接入云,要求接入云账号处于禁用状态 + operationId: network_PerformPurge + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkPurgeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformPurgeOutput' + summary: 清除IP子网数据 + tags: + - network + /networks/{id}/release-reserved-ip: + post: + description: 执行操作ReleaseReservedIp + operationId: network_PerformReleaseReservedIp + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkReleaseReservedIpInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformReleaseReservedIpOutput' + summary: 释放预留IP + tags: + - network + /networks/{id}/reserve-ip: + post: + description: 预留的IP不会被调度使用 + operationId: network_PerformReserveIp + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkReserveIpInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformReserveIpOutput' + summary: 预留IP + tags: + - network + /networks/{id}/reserved-ips: + get: + description: 获取指定信息ReservedIps + operationId: network_GetDetailsReservedIps + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsReservedIpsOutput' + summary: 获取指定信息ReservedIps + tags: + - network + /networks/{id}/set-bgp-type: + post: + description: 执行操作SetBgpType + operationId: network_PerformSetBgpType + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSetBgpTypeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSetBgpTypeOutput' + summary: 执行操作SetBgpType + tags: + - network + /networks/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: network_PerformSetClassMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - network + /networks/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: network_PerformSetSchedtag + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - network + /networks/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: network_PerformSetUserMetadata + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - network + /networks/{id}/split: + post: + description: 将一个IP子网分割成两个子网,仅本地IDC支持此操作 + operationId: network_PerformSplit + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSplitInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSplitOutput' + summary: 分割IP子网 + tags: + - network + /networks/{id}/status: + get: + description: 获取指定信息Status + operationId: network_GetDetailsStatus + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/network_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - network + post: + description: 执行操作Status + operationId: network_PerformStatus + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformStatusOutput' + summary: 更改IP子网状态 + tags: + - network + /networks/{id}/switch-wire: + post: + description: 执行操作SwitchWire + operationId: network_PerformSwitchWire + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSwitchWireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSwitchWireOutput' + summary: 执行操作SwitchWire + tags: + - network + /networks/{id}/sync: + post: + description: 本地IDC不支持此操作 + operationId: network_PerformSync + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSyncOutput' + summary: 同步接入云IP子网状态 + tags: + - network + /networks/{id}/syncstatus: + post: + description: 本地IDC不支持此操作 + operationId: network_PerformSyncstatus + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformSyncstatusOutput' + summary: 同步接入云IP子网状态 + tags: + - network + /networks/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: network_PerformUnfreeze + parameters: + - description: The Id or Name of network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - network + /networks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: network_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/network_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - network + /networks/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: network_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/network_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - network + /networks/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: network_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/network_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - network + /networks/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: network_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/network_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - network + /networks/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: network_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/network_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - network + /networks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: network_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - network + /networks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: network_GetPropertySplitable + responses: + "200": + $ref: '#/responses/network_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - network + /networks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: network_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/network_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - network + /networks/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: network_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/network_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - network + /networks/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: network_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/network_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - network + /networks/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: network_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/network_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - network + /networks/try-create-network: + post: + description: 执行操作TryCreateNetwork + operationId: network_PerformTryCreateNetwork + parameters: + - in: body + name: body + schema: + properties: + network: + $ref: '#/definitions/NetworkTryCreateNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/network_PerformTryCreateNetworkOutput' + summary: 执行操作TryCreateNetwork + tags: + - network + /policy_assignments: + get: + description: 列表 + operationId: policy_assignment_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: Policydefinition + type: string + responses: + "200": + $ref: '#/responses/policy_assignment_ListItemFilterOutput' + summary: 策略分配列表 + tags: + - policy_assignment + post: + description: 新建 + operationId: policy_assignment_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + policy_assignment: + $ref: '#/definitions/PolicyAssignmentCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_ValidateCreateDataOutput' + summary: 新建 + tags: + - policy_assignment + /policy_assignments/{id}: + delete: + description: 删除 + operationId: policy_assignment_CustomizeDelete + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_CustomizeDeleteOutput' + summary: 删除 + tags: + - policy_assignment + get: + description: 获取详情 + operationId: policy_assignment_FetchCustomizeColumns + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - policy_assignment + put: + description: 更新 + operationId: policy_assignment_ValidateUpdateData + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + $ref: '#/definitions/DomainLevelResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_ValidateUpdateDataOutput' + summary: 更新 + tags: + - policy_assignment + /policy_assignments/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: policy_assignment_PerformChangeOwner + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - policy_assignment + /policy_assignments/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: policy_assignment_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - policy_assignment + /policy_assignments/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: policy_assignment_GetDetailsClassMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - policy_assignment + post: + description: 执行操作ClassMetadata + operationId: policy_assignment_PerformClassMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - policy_assignment + /policy_assignments/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: policy_assignment_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_assignment_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - policy_assignment + /policy_assignments/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: policy_assignment_PerformSetClassMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - policy_assignment + /policy_assignments/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: policy_assignment_PerformSetUserMetadata + parameters: + - description: The Id or Name of policy_assignment + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - policy_assignment + /policy_assignments/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: policy_assignment_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - policy_assignment + /policy_assignments/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: policy_assignment_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - policy_assignment + /policy_assignments/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: policy_assignment_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - policy_assignment + /policy_assignments/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: policy_assignment_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + policy_assignment: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_assignment_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - policy_assignment + /policy_assignments/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: policy_assignment_GetPropertySplitable + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - policy_assignment + /policy_assignments/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: policy_assignment_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - policy_assignment + /policy_assignments/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: policy_assignment_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - policy_assignment + /policy_assignments/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: policy_assignment_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/policy_assignment_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - policy_assignment + /policy_definitions: + get: + description: 列表 + operationId: policy_definition_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/policy_definition_ListItemFilterOutput' + summary: 策略列表 + tags: + - policy_definition + post: + description: 新建 + operationId: policy_definition_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + policy_definition: + $ref: '#/definitions/PolicyDefinitionCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_ValidateCreateDataOutput' + summary: 新建 + tags: + - policy_definition + /policy_definitions/{id}: + delete: + description: 删除 + operationId: policy_definition_CustomizeDelete + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_CustomizeDeleteOutput' + summary: 删除 + tags: + - policy_definition + get: + description: 获取详情 + operationId: policy_definition_FetchCustomizeColumns + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - policy_definition + put: + description: 更新 + operationId: policy_definition_ValidateUpdateData + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_ValidateUpdateDataOutput' + summary: 更新 + tags: + - policy_definition + /policy_definitions/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: policy_definition_GetDetailsClassMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - policy_definition + post: + description: 执行操作ClassMetadata + operationId: policy_definition_PerformClassMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - policy_definition + /policy_definitions/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: policy_definition_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - policy_definition + /policy_definitions/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: policy_definition_PerformSetClassMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - policy_definition + /policy_definitions/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: policy_definition_PerformSetUserMetadata + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - policy_definition + /policy_definitions/{id}/status: + get: + description: 获取指定信息Status + operationId: policy_definition_GetDetailsStatus + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_definition_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - policy_definition + post: + description: 执行操作Status + operationId: policy_definition_PerformStatus + parameters: + - description: The Id or Name of policy_definition + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy_definition: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformStatusOutput' + summary: 更新资源状态 + tags: + - policy_definition + /policy_definitions/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: policy_definition_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - policy_definition + /policy_definitions/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: policy_definition_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + policy_definition: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_definition_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - policy_definition + /policy_definitions/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: policy_definition_GetPropertySplitable + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - policy_definition + /policy_definitions/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: policy_definition_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - policy_definition + /policy_definitions/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: policy_definition_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - policy_definition + /policy_definitions/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: policy_definition_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - policy_definition + /policy_definitions/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: policy_definition_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/policy_definition_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - policy_definition + /project_mappings: + get: + description: 列表 + operationId: project_mapping_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/project_mapping_ListItemFilterOutput' + summary: 列出项目映射表 + tags: + - project_mapping + post: + description: 新建 + operationId: project_mapping_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + project_mapping: + $ref: '#/definitions/ProjectMappingCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_ValidateCreateDataOutput' + summary: 新建 + tags: + - project_mapping + /project_mappings/{id}: + delete: + description: 删除 + operationId: project_mapping_CustomizeDelete + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_CustomizeDeleteOutput' + summary: 删除 + tags: + - project_mapping + get: + description: 获取详情 + operationId: project_mapping_FetchCustomizeColumns + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - project_mapping + put: + description: 更新 + operationId: project_mapping_ValidateUpdateData + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_ValidateUpdateDataOutput' + summary: 更新 + tags: + - project_mapping + /project_mappings/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: project_mapping_PerformChangeOwner + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - project_mapping + /project_mappings/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: project_mapping_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - project_mapping + /project_mappings/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: project_mapping_GetDetailsClassMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - project_mapping + post: + description: 执行操作ClassMetadata + operationId: project_mapping_PerformClassMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - project_mapping + /project_mappings/{id}/disable: + post: + description: 执行操作Disable + operationId: project_mapping_PerformDisable + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformDisableOutput' + summary: 禁用资源映射 + tags: + - project_mapping + /project_mappings/{id}/enable: + post: + description: 执行操作Enable + operationId: project_mapping_PerformEnable + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformEnableOutput' + summary: 启用资源映射 + tags: + - project_mapping + /project_mappings/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: project_mapping_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - project_mapping + /project_mappings/{id}/private: + post: + description: 执行操作Private + operationId: project_mapping_PerformPrivate + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformPrivateOutput' + summary: 执行操作Private + tags: + - project_mapping + /project_mappings/{id}/public: + post: + description: 执行操作Public + operationId: project_mapping_PerformPublic + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformPublicOutput' + summary: 执行操作Public + tags: + - project_mapping + /project_mappings/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: project_mapping_PerformSetClassMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - project_mapping + /project_mappings/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: project_mapping_PerformSetUserMetadata + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - project_mapping + /project_mappings/{id}/status: + get: + description: 获取指定信息Status + operationId: project_mapping_GetDetailsStatus + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_mapping_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - project_mapping + post: + description: 执行操作Status + operationId: project_mapping_PerformStatus + parameters: + - description: The Id or Name of project_mapping + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformStatusOutput' + summary: 更新资源状态 + tags: + - project_mapping + /project_mappings/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: project_mapping_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - project_mapping + /project_mappings/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: project_mapping_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - project_mapping + /project_mappings/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: project_mapping_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - project_mapping + /project_mappings/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: project_mapping_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + project_mapping: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_mapping_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - project_mapping + /project_mappings/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: project_mapping_GetPropertySplitable + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - project_mapping + /project_mappings/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: project_mapping_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - project_mapping + /project_mappings/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: project_mapping_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - project_mapping + /project_mappings/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: project_mapping_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - project_mapping + /project_mappings/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: project_mapping_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/project_mapping_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - project_mapping + /project_quotas/{scope}: + get: + description: 获取所有项目或者域的项目配额 + operationId: models_ListProjectQuotas + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListProjectQuotasOutput' + summary: 获取所有项目或者域的项目配额 + tags: + - project_quota + /project_quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的项目配额 + operationId: models_GetProjectQuota + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + responses: + "200": + $ref: '#/responses/models_GetProjectQuotaOutput' + summary: 获取指定项目或者域的项目配额 + tags: + - project_quota + post: + description: 设置指定项目或者域的项目配额 + operationId: models_SetProjectQuotas + parameters: + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - in: body + name: body + schema: + properties: + project_quotas: + $ref: '#/definitions/SetProjectQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetProjectQuotasOutput' + summary: 设置指定项目或者域的项目配额 + tags: + - project_quota + /quotas/{scope}: + get: + description: 获取所有项目或者域的主机配额 + operationId: models_ListQuotas + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListQuotasOutput' + summary: 获取所有项目或者域的主机配额 + tags: + - quota + /quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的主机配额 + operationId: models_GetQuota + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_GetQuotaOutput' + summary: 获取指定项目或者域的主机配额 + tags: + - quota + post: + description: 设置指定项目或者域的主机配额 + operationId: models_SetQuotas + parameters: + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - in: body + name: body + schema: + properties: + quotas: + $ref: '#/definitions/SetQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetQuotasOutput' + summary: 设置指定项目或者域的主机配额 + tags: + - quota + /region_quotas/{scope}: + get: + description: 获取所有项目或者域的区域配额 + operationId: models_ListRegionQuotas + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListRegionQuotasOutput' + summary: 获取所有项目或者域的区域配额 + tags: + - region_quota + /region_quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的区域配额 + operationId: models_GetRegionQuota + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_GetRegionQuotaOutput' + summary: 获取指定项目或者域的区域配额 + tags: + - region_quota + post: + description: 设置指定项目或者域的区域配额 + operationId: models_SetRegionQuotas + parameters: + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - in: body + name: body + schema: + properties: + region_quotas: + $ref: '#/definitions/SetRegionQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetRegionQuotasOutput' + summary: 设置指定项目或者域的区域配额 + tags: + - region_quota + /reservedips: + get: + description: 列表 + operationId: reservedip_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: list all reserved ips, including expired ones + in: query + name: all + type: boolean + x-go-name: All + - description: ip_addr + in: query + items: + type: string + name: ip_addr + type: array + x-go-name: IpAddr + - description: 状态 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/reservedip_ListItemFilterOutput' + summary: 预留IP地址列表 + tags: + - reservedip + post: + description: 新建 + operationId: reservedip_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + reservedip: + $ref: '#/definitions/ResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/reservedip_ValidateCreateDataOutput' + summary: 新建 + tags: + - reservedip + /reservedips/{id}: + delete: + description: 删除 + operationId: reservedip_CustomizeDelete + parameters: + - description: The Id or Name of reservedip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/reservedip_CustomizeDeleteOutput' + summary: 删除 + tags: + - reservedip + get: + description: 获取详情 + operationId: reservedip_FetchCustomizeColumns + parameters: + - description: The Id or Name of reservedip + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/reservedip_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - reservedip + put: + description: 更新 + operationId: reservedip_ValidateUpdateData + parameters: + - description: The Id or Name of reservedip + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + reservedip: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/reservedip_ValidateUpdateDataOutput' + summary: 更新 + tags: + - reservedip + /reservedips/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: reservedip_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/reservedip_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - reservedip + /reservedips/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: reservedip_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + reservedip: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/reservedip_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - reservedip + /reservedips/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: reservedip_GetPropertySplitable + responses: + "200": + $ref: '#/responses/reservedip_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - reservedip + /reservedips/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: reservedip_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/reservedip_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - reservedip + /route_table_associations: + get: + description: 列表 + operationId: route_table_association_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - in: query + name: RouteTableId + type: string + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/route_table_association_ListItemFilterOutput' + summary: 列表 + tags: + - route_table_association + post: + description: 新建 + operationId: route_table_association_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_ValidateCreateDataOutput' + summary: 新建 + tags: + - route_table_association + /route_table_associations/{id}: + delete: + description: 删除 + operationId: route_table_association_CustomizeDelete + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_CustomizeDeleteOutput' + summary: 删除 + tags: + - route_table_association + get: + description: 获取详情 + operationId: route_table_association_FetchCustomizeColumns + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - route_table_association + put: + description: 更新 + operationId: route_table_association_ValidateUpdateData + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_ValidateUpdateDataOutput' + summary: 更新 + tags: + - route_table_association + /route_table_associations/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: route_table_association_GetDetailsClassMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - route_table_association + post: + description: 执行操作ClassMetadata + operationId: route_table_association_PerformClassMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - route_table_association + /route_table_associations/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: route_table_association_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - route_table_association + /route_table_associations/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: route_table_association_PerformSetClassMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table_association + /route_table_associations/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: route_table_association_PerformSetUserMetadata + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - route_table_association + /route_table_associations/{id}/status: + get: + description: 获取指定信息Status + operationId: route_table_association_GetDetailsStatus + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_association_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - route_table_association + post: + description: 执行操作Status + operationId: route_table_association_PerformStatus + parameters: + - description: The Id or Name of route_table_association + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_association: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformStatusOutput' + summary: 更新资源状态 + tags: + - route_table_association + /route_table_associations/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: route_table_association_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - route_table_association + /route_table_associations/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: route_table_association_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + route_table_association: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_association_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - route_table_association + /route_table_associations/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: route_table_association_GetPropertySplitable + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - route_table_association + /route_table_associations/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: route_table_association_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - route_table_association + /route_table_associations/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: route_table_association_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - route_table_association + /route_table_associations/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: route_table_association_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - route_table_association + /route_table_associations/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: route_table_association_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/route_table_association_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - route_table_association + /route_table_route_sets: + get: + description: 列表 + operationId: route_table_route_set_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - in: query + name: RouteTableId + type: string + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: type + type: string + x-go-name: Type + - in: query + name: next_hop_type + type: string + x-go-name: NextHopType + - in: query + name: next_hop_id + type: string + x-go-name: NextHopId + - in: query + name: cidr + type: string + x-go-name: Cidr + responses: + "200": + $ref: '#/responses/route_table_route_set_ListItemFilterOutput' + summary: 列表 + tags: + - route_table_route_set + post: + description: 新建 + operationId: route_table_route_set_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + route_table_route_set: + $ref: '#/definitions/RouteTableRouteSetCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_ValidateCreateDataOutput' + summary: 新建 + tags: + - route_table_route_set + /route_table_route_sets/{id}: + delete: + description: 删除 + operationId: route_table_route_set_CustomizeDelete + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_CustomizeDeleteOutput' + summary: 删除 + tags: + - route_table_route_set + get: + description: 获取详情 + operationId: route_table_route_set_FetchCustomizeColumns + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - route_table_route_set + put: + description: 更新 + operationId: route_table_route_set_ValidateUpdateData + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + $ref: '#/definitions/RouteTableRouteSetUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_ValidateUpdateDataOutput' + summary: 更新 + tags: + - route_table_route_set + /route_table_route_sets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: route_table_route_set_GetDetailsClassMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - route_table_route_set + post: + description: 执行操作ClassMetadata + operationId: route_table_route_set_PerformClassMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - route_table_route_set + /route_table_route_sets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: route_table_route_set_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - route_table_route_set + /route_table_route_sets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: route_table_route_set_PerformSetClassMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table_route_set + /route_table_route_sets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: route_table_route_set_PerformSetUserMetadata + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - route_table_route_set + /route_table_route_sets/{id}/status: + get: + description: 获取指定信息Status + operationId: route_table_route_set_GetDetailsStatus + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_route_set_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - route_table_route_set + post: + description: 执行操作Status + operationId: route_table_route_set_PerformStatus + parameters: + - description: The Id or Name of route_table_route_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table_route_set: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformStatusOutput' + summary: 更新资源状态 + tags: + - route_table_route_set + /route_table_route_sets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: route_table_route_set_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - route_table_route_set + /route_table_route_sets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: route_table_route_set_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + route_table_route_set: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_route_set_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - route_table_route_set + /route_table_route_sets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: route_table_route_set_GetPropertySplitable + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - route_table_route_set + /route_table_route_sets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: route_table_route_set_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - route_table_route_set + /route_table_route_sets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: route_table_route_set_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - route_table_route_set + /route_table_route_sets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: route_table_route_set_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - route_table_route_set + /route_table_route_sets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: route_table_route_set_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/route_table_route_set_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - route_table_route_set + /route_tables: + get: + description: 列表 + operationId: route_table_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: filter by type + in: query + items: + type: string + name: type + type: array + x-go-name: Type + responses: + "200": + $ref: '#/responses/route_table_ListItemFilterOutput' + summary: VPC虚拟路由表列表 + tags: + - route_table + post: + description: 新建 + operationId: route_table_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + route_table: + $ref: '#/definitions/RouteTableCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_ValidateCreateDataOutput' + summary: 新建 + tags: + - route_table + /route_tables/{id}: + delete: + description: 删除 + operationId: route_table_CustomizeDelete + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_CustomizeDeleteOutput' + summary: 删除 + tags: + - route_table + get: + description: 获取详情 + operationId: route_table_FetchCustomizeColumns + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - route_table + put: + description: 更新 + operationId: route_table_ValidateUpdateData + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_ValidateUpdateDataOutput' + summary: 更新 + tags: + - route_table + /route_tables/{id}/add-routes: + post: + description: This is intended mainly for command line operations. + operationId: route_table_PerformAddRoutes + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_PerformAddRoutesOutput' + summary: PerformAddRoutes patches acl entries by adding then deleting the specified + acls. + tags: + - route_table + /route_tables/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: route_table_PerformChangeOwner + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - route_table + /route_tables/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: route_table_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - route_table + /route_tables/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: route_table_GetDetailsClassMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - route_table + post: + description: 执行操作ClassMetadata + operationId: route_table_PerformClassMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - route_table + /route_tables/{id}/del-routes: + post: + description: 执行操作DelRoutes + operationId: route_table_PerformDelRoutes + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_PerformDelRoutesOutput' + summary: 执行操作DelRoutes + tags: + - route_table + /route_tables/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: route_table_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - route_table + /route_tables/{id}/private: + post: + description: 执行操作Private + operationId: route_table_PerformPrivate + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformPrivateOutput' + summary: 执行操作Private + tags: + - route_table + /route_tables/{id}/public: + post: + description: 执行操作Public + operationId: route_table_PerformPublic + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformPublicOutput' + summary: 执行操作Public + tags: + - route_table + /route_tables/{id}/purge: + post: + description: 执行操作Purge + operationId: route_table_PerformPurge + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - route_table + /route_tables/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: route_table_PerformSetClassMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - route_table + /route_tables/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: route_table_PerformSetUserMetadata + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - route_table + /route_tables/{id}/status: + get: + description: 获取指定信息Status + operationId: route_table_GetDetailsStatus + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/route_table_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - route_table + post: + description: 执行操作Status + operationId: route_table_PerformStatus + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformStatusOutput' + summary: 更新资源状态 + tags: + - route_table + /route_tables/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: route_table_PerformSyncstatus + parameters: + - description: The Id or Name of route_table + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/VpcSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformSyncstatusOutput' + summary: 执行操作Syncstatus + tags: + - route_table + /route_tables/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: route_table_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/route_table_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - route_table + /route_tables/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: route_table_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/route_table_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - route_table + /route_tables/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: route_table_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/route_table_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - route_table + /route_tables/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: route_table_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + route_table: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/route_table_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - route_table + /route_tables/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: route_table_GetPropertySplitable + responses: + "200": + $ref: '#/responses/route_table_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - route_table + /route_tables/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: route_table_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/route_table_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - route_table + /route_tables/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: route_table_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/route_table_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - route_table + /route_tables/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: route_table_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/route_table_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - route_table + /route_tables/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: route_table_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/route_table_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - route_table + /scaling_activities: + get: + description: 列表 + operationId: scaling_activity_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 'description: 伸缩组 Id or Name' + example: sg-1234 + in: query + name: scaling_group + type: string + x-go-name: ScalingGroup + responses: + "200": + $ref: '#/responses/scaling_activity_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_activity + post: + description: 新建 + operationId: scaling_activity_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_activity: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_activity + /scaling_activities/{id}: + delete: + description: 删除 + operationId: scaling_activity_CustomizeDelete + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_activity + get: + description: 获取详情 + operationId: scaling_activity_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_activity + put: + description: 更新 + operationId: scaling_activity_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_activity + /scaling_activities/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_activity_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_activity + post: + description: 执行操作ClassMetadata + operationId: scaling_activity_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_activity + /scaling_activities/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_activity_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_activity + /scaling_activities/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_activity_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_activity + /scaling_activities/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_activity_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_activity + /scaling_activities/{id}/status: + get: + description: 获取指定信息Status + operationId: scaling_activity_GetDetailsStatus + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_activity_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - scaling_activity + post: + description: 执行操作Status + operationId: scaling_activity_PerformStatus + parameters: + - description: The Id or Name of scaling_activity + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_activity: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformStatusOutput' + summary: 更新资源状态 + tags: + - scaling_activity + /scaling_activities/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_activity_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_activity + /scaling_activities/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_activity_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_activity: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_activity_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_activity + /scaling_activities/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_activity_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_activity + /scaling_activities/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_activity_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_activity + /scaling_activities/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: scaling_activity_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - scaling_activity + /scaling_activities/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_activity_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_activity + /scaling_activities/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_activity_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_activity_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_activity + /scaling_alarms: + get: + description: 列表 + operationId: scaling_alarm_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + responses: + "200": + $ref: '#/responses/scaling_alarm_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_alarm + post: + description: 新建 + operationId: scaling_alarm_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_alarm: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_alarm + /scaling_alarms/{id}: + delete: + description: 删除 + operationId: scaling_alarm_CustomizeDelete + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_alarm + get: + description: 获取详情 + operationId: scaling_alarm_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_alarm + put: + description: 更新 + operationId: scaling_alarm_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_alarm + /scaling_alarms/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_alarm_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_alarm + post: + description: 执行操作ClassMetadata + operationId: scaling_alarm_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_alarm + /scaling_alarms/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_alarm_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_alarm_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_alarm + /scaling_alarms/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_alarm_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_alarm + /scaling_alarms/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_alarm_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_alarm + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_alarm + /scaling_alarms/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_alarm_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_alarm + /scaling_alarms/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_alarm_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_alarm: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_alarm_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_alarm + /scaling_alarms/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_alarm_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_alarm + /scaling_alarms/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_alarm_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_alarm + /scaling_alarms/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_alarm_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_alarm + /scaling_alarms/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_alarm_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_alarm_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_alarm + /scaling_group_guests: + get: + description: 列表 + operationId: scaling_group_guest_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 以主机名称排序 + in: query + name: order_by_server + type: string + x-go-name: OrderByServer + responses: + "200": + $ref: '#/responses/scaling_group_guest_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_group_guest + post: + description: 新建 + operationId: scaling_group_guest_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_group_guest: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_guest_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_group_guest + /scaling_group_guests/{id}: + delete: + description: 删除 + operationId: scaling_group_guest_CustomizeDelete + parameters: + - description: The Id or Name of scaling_group_guest + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_guest_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_group_guest + get: + description: 获取详情 + operationId: scaling_group_guest_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_group_guest + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_guest_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_group_guest + put: + description: 更新 + operationId: scaling_group_guest_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_group_guest + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_guest_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_group_guest + /scaling_group_guests/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_group_guest_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_group_guest_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_group_guest + /scaling_group_guests/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_group_guest_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_guest_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_group_guest + /scaling_group_guests/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_group_guest_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_group_guest_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_group_guest + /scaling_group_guests/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_group_guest_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scaling_group_guest_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_group_guest + /scaling_group_networks: + get: + description: 列表 + operationId: scaling_group_network_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/scaling_group_network_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_group_network + post: + description: 新建 + operationId: scaling_group_network_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_group_network: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_network_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_group_network + /scaling_group_networks/{id}: + delete: + description: 删除 + operationId: scaling_group_network_CustomizeDelete + parameters: + - description: The Id or Name of scaling_group_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_network_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_group_network + get: + description: 获取详情 + operationId: scaling_group_network_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_group_network + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_network_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_group_network + put: + description: 更新 + operationId: scaling_group_network_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_group_network + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_network_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_group_network + /scaling_group_networks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_group_network_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_group_network_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_group_network + /scaling_group_networks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_group_network_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_group_network: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_network_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_group_network + /scaling_group_networks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_group_network_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_group_network_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_group_network + /scaling_group_networks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_group_network_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scaling_group_network_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_group_network + /scaling_groups: + get: + description: 列表 + operationId: scaling_group_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 负载均衡名称 + in: query + name: loadbalancer_id + type: string + x-go-name: LoadbalancerId + - description: 以负载均衡名称排序 + in: query + name: order_by_loadbalancer + type: string + x-go-name: OrderByLoadbalancer + - description: 负载均衡后端组ID或名称 + in: query + name: backend_group_id + type: string + x-go-name: BackendGroupId + - description: 以负载均衡后端组名称排序 + in: query + name: order_by_backend_group + type: string + x-go-name: OrderByBackendGroup + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 实例组（ID或Name） + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 按组名排序 + in: query + name: order_by_group + type: string + x-go-name: OrderByGroup + - description: 主机镜像 + in: query + name: guest_template_id + type: string + x-go-name: GuestTemplateId + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 'description: hypervisor' + example: kvm + in: query + name: hypervisor + type: string + x-go-name: Hypervisor + - description: 'desription: 平台' + example: OneCloud + in: query + name: brand + type: string + x-go-name: Brand + responses: + "200": + $ref: '#/responses/scaling_group_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_group + post: + description: 新建 + operationId: scaling_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_group: + $ref: '#/definitions/ScalingGroupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_group + /scaling_groups/{id}: + delete: + description: 删除 + operationId: scaling_group_CustomizeDelete + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_group + get: + description: 获取详情 + operationId: scaling_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_group + put: + description: 更新 + operationId: scaling_group_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_group + /scaling_groups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: scaling_group_PerformCancelDelete + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - scaling_group + /scaling_groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: scaling_group_PerformChangeOwner + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - scaling_group + /scaling_groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: scaling_group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - scaling_group + /scaling_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_group + post: + description: 执行操作ClassMetadata + operationId: scaling_group_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_group + /scaling_groups/{id}/disable: + post: + description: 执行操作Disable + operationId: scaling_group_PerformDisable + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformDisableOutput' + summary: 执行操作Disable + tags: + - scaling_group + /scaling_groups/{id}/enable: + post: + description: 执行操作Enable + operationId: scaling_group_PerformEnable + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformEnableOutput' + summary: 执行操作Enable + tags: + - scaling_group + /scaling_groups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: scaling_group_PerformFreeze + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - scaling_group + /scaling_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_group_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_group + /scaling_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_group + /scaling_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_group + /scaling_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: scaling_group_GetDetailsStatus + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - scaling_group + post: + description: 执行操作Status + operationId: scaling_group_PerformStatus + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - scaling_group + /scaling_groups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: scaling_group_PerformUnfreeze + parameters: + - description: The Id or Name of scaling_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - scaling_group + /scaling_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_group + /scaling_groups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: scaling_group_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - scaling_group + /scaling_groups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: scaling_group_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - scaling_group + /scaling_groups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: scaling_group_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - scaling_group + /scaling_groups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: scaling_group_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - scaling_group + /scaling_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_group + /scaling_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_group + /scaling_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_group_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_group + /scaling_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: scaling_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - scaling_group + /scaling_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_group + /scaling_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_group + /scaling_policies: + get: + description: 列表 + operationId: scaling_policy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 'description: 伸缩组 Id or Name' + example: sg-1234 + in: query + name: scaling_group + type: string + x-go-name: ScalingGroup + - description: 'description: trigger type' + enum: + - timing + - cycel + - alarm + example: alarm + in: query + name: trigger_type + type: string + x-go-name: TriggerType + responses: + "200": + $ref: '#/responses/scaling_policy_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_policy + post: + description: 新建 + operationId: scaling_policy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_policy: + $ref: '#/definitions/ScalingPolicyCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_policy + /scaling_policies/{id}: + delete: + description: 删除 + operationId: scaling_policy_CustomizeDelete + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_policy + get: + description: 获取详情 + operationId: scaling_policy_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_policy + put: + description: 更新 + operationId: scaling_policy_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_policy + /scaling_policies/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: scaling_policy_PerformCancelDelete + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - scaling_policy + /scaling_policies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: scaling_policy_PerformChangeOwner + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - scaling_policy + /scaling_policies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: scaling_policy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - scaling_policy + /scaling_policies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_policy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_policy + post: + description: 执行操作ClassMetadata + operationId: scaling_policy_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_policy + /scaling_policies/{id}/disable: + post: + description: 执行操作Disable + operationId: scaling_policy_PerformDisable + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformDisableOutput' + summary: 执行操作Disable + tags: + - scaling_policy + /scaling_policies/{id}/enable: + post: + description: 执行操作Enable + operationId: scaling_policy_PerformEnable + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformEnableOutput' + summary: 执行操作Enable + tags: + - scaling_policy + /scaling_policies/{id}/freeze: + post: + description: 执行操作Freeze + operationId: scaling_policy_PerformFreeze + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - scaling_policy + /scaling_policies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_policy_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_policy + /scaling_policies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_policy_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_policy + /scaling_policies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_policy_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_policy + /scaling_policies/{id}/status: + get: + description: 获取指定信息Status + operationId: scaling_policy_GetDetailsStatus + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - scaling_policy + post: + description: 执行操作Status + operationId: scaling_policy_PerformStatus + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformStatusOutput' + summary: 更新资源状态 + tags: + - scaling_policy + /scaling_policies/{id}/trigger: + post: + description: 执行操作Trigger + operationId: scaling_policy_PerformTrigger + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_policy_PerformTriggerOutput' + summary: 执行操作Trigger + tags: + - scaling_policy + /scaling_policies/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: scaling_policy_PerformUnfreeze + parameters: + - description: The Id or Name of scaling_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - scaling_policy + /scaling_policies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_policy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_policy + /scaling_policies/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: scaling_policy_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - scaling_policy + /scaling_policies/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: scaling_policy_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - scaling_policy + /scaling_policies/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: scaling_policy_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - scaling_policy + /scaling_policies/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: scaling_policy_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - scaling_policy + /scaling_policies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_policy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_policy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_policy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_policy + /scaling_policies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_policy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_policy + /scaling_policies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_policy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_policy + /scaling_policies/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: scaling_policy_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - scaling_policy + /scaling_policies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_policy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_policy + /scaling_policies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_policy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_policy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_policy + /scaling_timers: + get: + description: 列表 + operationId: scaling_timer_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + responses: + "200": + $ref: '#/responses/scaling_timer_ListItemFilterOutput' + summary: 列表 + tags: + - scaling_timer + post: + description: 新建 + operationId: scaling_timer_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scaling_timer: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_ValidateCreateDataOutput' + summary: 新建 + tags: + - scaling_timer + /scaling_timers/{id}: + delete: + description: 删除 + operationId: scaling_timer_CustomizeDelete + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_CustomizeDeleteOutput' + summary: 删除 + tags: + - scaling_timer + get: + description: 获取详情 + operationId: scaling_timer_FetchCustomizeColumns + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scaling_timer + put: + description: 更新 + operationId: scaling_timer_ValidateUpdateData + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scaling_timer + /scaling_timers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scaling_timer_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scaling_timer + post: + description: 执行操作ClassMetadata + operationId: scaling_timer_PerformClassMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scaling_timer + /scaling_timers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scaling_timer_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scaling_timer_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scaling_timer + /scaling_timers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scaling_timer_PerformSetClassMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scaling_timer + /scaling_timers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scaling_timer_PerformSetUserMetadata + parameters: + - description: The Id or Name of scaling_timer + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scaling_timer + /scaling_timers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scaling_timer_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scaling_timer + /scaling_timers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scaling_timer_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scaling_timer: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scaling_timer_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scaling_timer + /scaling_timers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scaling_timer_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scaling_timer + /scaling_timers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scaling_timer_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scaling_timer + /scaling_timers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scaling_timer_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scaling_timer + /scaling_timers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scaling_timer_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scaling_timer_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scaling_timer + /schedpolicies: + get: + description: 列表 + operationId: schedpolicy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 按调度标签名称排序 + in: query + name: order_by_schedtag + pattern: asc|desc + type: string + x-go-name: OrderBySchedtag + - description: 按调度标签资源类型排序 + in: query + name: order_by_resource_type + pattern: asc|desc + type: string + x-go-name: OrderByResourceType + - in: query + items: + type: string + name: strategy + type: array + x-go-name: Strategy + - in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/schedpolicy_ListItemFilterOutput' + summary: 动态调度策略列表 + tags: + - schedpolicy + post: + description: 新建 + operationId: schedpolicy_ValidateCreateData + responses: + "200": + $ref: '#/responses/schedpolicy_ValidateCreateDataOutput' + summary: 新建 + tags: + - schedpolicy + /schedpolicies/{id}: + delete: + description: 删除 + operationId: schedpolicy_CustomizeDelete + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_CustomizeDeleteOutput' + summary: 删除 + tags: + - schedpolicy + get: + description: 获取详情 + operationId: schedpolicy_FetchCustomizeColumns + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - schedpolicy + put: + description: 更新 + operationId: schedpolicy_ValidateUpdateData + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - schedpolicy + /schedpolicies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: schedpolicy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - schedpolicy + post: + description: 执行操作ClassMetadata + operationId: schedpolicy_PerformClassMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - schedpolicy + /schedpolicies/{id}/evaluate: + post: + description: 执行操作Evaluate + operationId: schedpolicy_PerformEvaluate + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_PerformEvaluateOutput' + summary: 执行操作Evaluate + tags: + - schedpolicy + /schedpolicies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: schedpolicy_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedpolicy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - schedpolicy + /schedpolicies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: schedpolicy_PerformSetClassMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - schedpolicy + /schedpolicies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: schedpolicy_PerformSetUserMetadata + parameters: + - description: The Id or Name of schedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - schedpolicy + /schedpolicies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: schedpolicy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - schedpolicy + /schedpolicies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: schedpolicy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + schedpolicy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedpolicy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - schedpolicy + /schedpolicies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: schedpolicy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - schedpolicy + /schedpolicies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: schedpolicy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - schedpolicy + /schedpolicies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: schedpolicy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - schedpolicy + /schedpolicies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: schedpolicy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/schedpolicy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - schedpolicy + /schedtags: + get: + description: 列表 + operationId: schedtag_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: fitler by resource_type + in: query + items: + type: string + name: resource_type + type: array + x-go-name: ResourceType + - in: query + items: + type: string + name: default_strategy + type: array + x-go-name: DefaultStrategy + responses: + "200": + $ref: '#/responses/schedtag_ListItemFilterOutput' + summary: 调度标签列表 + tags: + - schedtag + post: + description: 新建 + operationId: schedtag_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + schedtag: + $ref: '#/definitions/SchedtagCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_ValidateCreateDataOutput' + summary: 新建 + tags: + - schedtag + /schedtags/{id}: + delete: + description: 删除 + operationId: schedtag_CustomizeDelete + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_CustomizeDeleteOutput' + summary: 删除 + tags: + - schedtag + get: + description: 获取详情 + operationId: schedtag_FetchCustomizeColumns + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - schedtag + put: + description: 更新 + operationId: schedtag_ValidateUpdateData + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_ValidateUpdateDataOutput' + summary: 更新 + tags: + - schedtag + /schedtags/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: schedtag_GetDetailsClassMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - schedtag + post: + description: 执行操作ClassMetadata + operationId: schedtag_PerformClassMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - schedtag + /schedtags/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: schedtag_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - schedtag + /schedtags/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: schedtag_PerformSetClassMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - schedtag + /schedtags/{id}/set-resource: + post: + description: 执行操作SetResource + operationId: schedtag_PerformSetResource + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagSetResourceInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformSetResourceOutput' + summary: 执行操作SetResource + tags: + - schedtag + /schedtags/{id}/set-scope: + post: + description: 执行操作SetScope + operationId: schedtag_PerformSetScope + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/schedtag_PerformSetScopeOutput' + summary: 执行操作SetScope + tags: + - schedtag + /schedtags/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: schedtag_PerformSetUserMetadata + parameters: + - description: The Id or Name of schedtag + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - schedtag + /schedtags/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: schedtag_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/schedtag_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - schedtag + /schedtags/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: schedtag_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + schedtag: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/schedtag_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - schedtag + /schedtags/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: schedtag_GetPropertySplitable + responses: + "200": + $ref: '#/responses/schedtag_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - schedtag + /schedtags/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: schedtag_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/schedtag_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - schedtag + /schedtags/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: schedtag_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/schedtag_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - schedtag + /schedtags/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: schedtag_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/schedtag_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - schedtag + /security_group_caches: + get: + description: 列表 + operationId: security_group_cache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + responses: + "200": + $ref: '#/responses/security_group_cache_ListItemFilterOutput' + summary: 安全组缓存列表 + tags: + - security_group_cache + post: + description: 新建 + operationId: security_group_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + security_group_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - security_group_cache + /security_group_caches/{id}: + delete: + description: 删除 + operationId: security_group_cache_CustomizeDelete + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - security_group_cache + get: + description: 获取详情 + operationId: security_group_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - security_group_cache + put: + description: 更新 + operationId: security_group_cache_ValidateUpdateData + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - security_group_cache + /security_group_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: security_group_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - security_group_cache + post: + description: 执行操作ClassMetadata + operationId: security_group_cache_PerformClassMetadata + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - security_group_cache + /security_group_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: security_group_cache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - security_group_cache + /security_group_caches/{id}/references: + get: + description: 获取指定信息References + operationId: security_group_cache_GetDetailsReferences + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_cache_GetDetailsReferencesOutput' + summary: 获取引用信息 + tags: + - security_group_cache + /security_group_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: security_group_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - security_group_cache + /security_group_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: security_group_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - security_group_cache + /security_group_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: security_group_cache_GetDetailsStatus + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - security_group_cache + post: + description: 执行操作Status + operationId: security_group_cache_PerformStatus + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - security_group_cache + /security_group_caches/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: security_group_cache_PerformSyncstatus + parameters: + - description: The Id or Name of security_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group_cache: + $ref: '#/definitions/DiskSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_cache_PerformSyncstatusOutput' + summary: 同步安全组缓存状态 + tags: + - security_group_cache + /security_group_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: security_group_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/security_group_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - security_group_cache + /security_group_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: security_group_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + security_group_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - security_group_cache + /security_group_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: security_group_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/security_group_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - security_group_cache + /security_group_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: security_group_cache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/security_group_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - security_group_cache + /security_group_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: security_group_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/security_group_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - security_group_cache + /security_group_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: security_group_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/security_group_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - security_group_cache + /security_group_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: security_group_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/security_group_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - security_group_cache + /security_group_rules: + get: + description: 列表 + operationId: security_group_rule_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + - in: query + items: + type: string + name: projects + type: array + x-go-name: Projects + - description: 以direction字段过滤安全组规则 + in: query + name: direction + type: string + x-go-name: Direction + - description: 以action字段过滤安全组规则 + in: query + name: action + type: string + x-go-name: Action + - description: 以protocol字段过滤安全组规则 + in: query + name: protocol + type: string + x-go-name: Protocol + - description: 以ports字段过滤安全组规则 + in: query + name: ports + type: string + x-go-name: Ports + - description: 根据ip模糊匹配安全组规则 + in: query + name: ip + type: string + x-go-name: Ip + responses: + "200": + $ref: '#/responses/security_group_rule_ListItemFilterOutput' + summary: 安全组规则列表 + tags: + - security_group_rule + post: + description: 新建 + operationId: security_group_rule_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + security_group_rule: + $ref: '#/definitions/SSecgroupRuleCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_rule_ValidateCreateDataOutput' + summary: 新建 + tags: + - security_group_rule + /security_group_rules/{id}: + delete: + description: 删除 + operationId: security_group_rule_CustomizeDelete + parameters: + - description: The Id or Name of security_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_rule_CustomizeDeleteOutput' + summary: 删除 + tags: + - security_group_rule + get: + description: 获取详情 + operationId: security_group_rule_FetchCustomizeColumns + parameters: + - description: The Id or Name of security_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_rule_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - security_group_rule + put: + description: 更新 + operationId: security_group_rule_ValidateUpdateData + parameters: + - description: The Id or Name of security_group_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group_rule: + $ref: '#/definitions/SSecgroupRuleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_rule_ValidateUpdateDataOutput' + summary: 更新 + tags: + - security_group_rule + /security_group_rules/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: security_group_rule_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/security_group_rule_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - security_group_rule + /security_group_rules/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: security_group_rule_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + security_group_rule: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_rule_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - security_group_rule + /security_group_rules/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: security_group_rule_GetPropertySplitable + responses: + "200": + $ref: '#/responses/security_group_rule_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - security_group_rule + /security_group_rules/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: security_group_rule_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/security_group_rule_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - security_group_rule + /security_groups: + get: + description: 列表 + operationId: security_group_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 主机（ID或Name） + in: query + name: server_id + type: string + x-go-name: ServerId + - description: RDS实例(ID or Name) + in: query + name: dbinstance_id + type: string + x-go-name: DBInstanceId + - description: 弹性缓存实例(ID or Name) + in: query + name: elasticcache_id + type: string + x-go-name: ElasticcacheId + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: equals + in: query + name: Equals + type: string + - description: 按缓存数量排序 + in: query + name: order_by_cache_cnt + pattern: asc|desc + type: string + x-go-name: OrderByCacheCnt + - description: 按缓存关联主机数排序 + in: query + name: order_by_guest_cnt + pattern: asc|desc + type: string + x-go-name: OrderByGuestCnt + - description: 模糊过滤规则中含有指定ip的安全组 + example: 10.10.2.1 + in: query + name: ip + type: string + x-go-name: Ip + - description: 精确匹配规则中含有指定端口的安全组 + example: 100-200 + in: query + name: ports + type: string + x-go-name: Ports + - default: all + description: '指定过滤规则的方向(仅在指定ip或ports时生效) choices: all|in|out' + example: in + in: query + name: direction + type: string + x-go-name: Direction + - in: query + name: witch_cache + type: boolean + x-go-name: WithCache + responses: + "200": + $ref: '#/responses/security_group_ListItemFilterOutput' + summary: 安全组列表 + tags: + - security_group + post: + description: 新建 + operationId: security_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + security_group: + $ref: '#/definitions/SSecgroupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - security_group + /security_groups/{id}: + delete: + description: 删除 + operationId: security_group_CustomizeDelete + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - security_group + get: + description: 获取详情 + operationId: security_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - security_group + put: + description: 更新 + operationId: security_group_ValidateUpdateData + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - security_group + /security_groups/{id}/add-rule: + post: + description: 执行操作AddRule + operationId: security_group_PerformAddRule + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_PerformAddRuleOutput' + summary: 执行操作AddRule + tags: + - security_group + /security_groups/{id}/cache-secgroup: + post: + description: 执行操作CacheSecgroup + operationId: security_group_PerformCacheSecgroup + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SecurityGroupCacheInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformCacheSecgroupOutput' + summary: 执行操作CacheSecgroup + tags: + - security_group + /security_groups/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: security_group_PerformCancelDelete + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - security_group + /security_groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: security_group_PerformChangeOwner + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - security_group + /security_groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: security_group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - security_group + /security_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: security_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - security_group + post: + description: 执行操作ClassMetadata + operationId: security_group_PerformClassMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - security_group + /security_groups/{id}/clone: + post: + description: 执行操作Clone + operationId: security_group_PerformClone + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SecurityGroupCloneInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformCloneOutput' + summary: 执行操作Clone + tags: + - security_group + /security_groups/{id}/freeze: + post: + description: 执行操作Freeze + operationId: security_group_PerformFreeze + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - security_group + /security_groups/{id}/import-rules: + post: + description: 执行操作ImportRules + operationId: security_group_PerformImportRules + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupImportRulesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformImportRulesOutput' + summary: 执行操作ImportRules + tags: + - security_group + /security_groups/{id}/merge: + post: + description: 执行操作Merge + operationId: security_group_PerformMerge + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupMergeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformMergeOutput' + summary: 执行操作Merge + tags: + - security_group + /security_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: security_group_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - security_group + /security_groups/{id}/private: + post: + description: 执行操作Private + operationId: security_group_PerformPrivate + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformPrivateOutput' + summary: 执行操作Private + tags: + - security_group + /security_groups/{id}/public: + post: + description: 执行操作Public + operationId: security_group_PerformPublic + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformPublicOutput' + summary: 执行操作Public + tags: + - security_group + /security_groups/{id}/purge: + post: + description: 执行操作Purge + operationId: security_group_PerformPurge + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - security_group + /security_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: security_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - security_group + /security_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: security_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - security_group + /security_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: security_group_GetDetailsStatus + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - security_group + post: + description: 执行操作Status + operationId: security_group_PerformStatus + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - security_group + /security_groups/{id}/uncache-secgroup: + post: + description: 执行操作UncacheSecgroup + operationId: security_group_PerformUncacheSecgroup + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/security_group_PerformUncacheSecgroupOutput' + summary: 执行操作UncacheSecgroup + tags: + - security_group + /security_groups/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: security_group_PerformUnfreeze + parameters: + - description: The Id or Name of security_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - security_group + /security_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: security_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/security_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - security_group + /security_groups/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: security_group_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/security_group_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - security_group + /security_groups/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: security_group_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/security_group_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - security_group + /security_groups/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: security_group_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/security_group_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - security_group + /security_groups/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: security_group_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/security_group_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - security_group + /security_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: security_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + security_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/security_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - security_group + /security_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: security_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/security_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - security_group + /security_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: security_group_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/security_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - security_group + /security_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: security_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/security_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - security_group + /security_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: security_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/security_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - security_group + /security_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: security_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/security_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - security_group + /server_skus: + get: + description: 列表 + operationId: server_sku_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter sku by memory size in MB + in: query + items: + format: int64 + type: integer + name: memory_size_mb + type: array + x-go-name: MemorySizeMb + - description: filter sku by CPU core count + in: query + items: + format: int64 + type: integer + name: cpu_core_count + type: array + x-go-name: CpuCoreCount + - description: 后付费状态 + in: query + name: postpaid_status + type: string + x-go-name: PostpaidStatus + - description: 预付费状态 + in: query + name: prepaid_status + type: string + x-go-name: PrepaidStatus + - description: 按套餐名称去重 + in: query + name: distinct + type: boolean + x-go-name: Distinct + - description: 按关联虚拟机数量排序 + in: query + name: order_by_total_guest_count + type: string + x-go-name: OrderByTotalGuestCount + responses: + "200": + $ref: '#/responses/server_sku_ListItemFilterOutput' + summary: 主机套餐规格列表 + tags: + - server_sku + post: + description: 新建 + operationId: server_sku_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + server_sku: + $ref: '#/definitions/ServerSkuCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_ValidateCreateDataOutput' + summary: 新建 + tags: + - server_sku + /server_skus/{id}: + delete: + description: 删除 + operationId: server_sku_CustomizeDelete + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_CustomizeDeleteOutput' + summary: 删除 + tags: + - server_sku + get: + description: 获取详情 + operationId: server_sku_FetchCustomizeColumns + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - server_sku + put: + description: 更新 + operationId: server_sku_ValidateUpdateData + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_ValidateUpdateDataOutput' + summary: 更新 + tags: + - server_sku + /server_skus/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: server_sku_GetDetailsClassMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - server_sku + post: + description: 执行操作ClassMetadata + operationId: server_sku_PerformClassMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - server_sku + /server_skus/{id}/disable: + post: + description: 执行操作Disable + operationId: server_sku_PerformDisable + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformDisableOutput' + summary: 禁用资源 + tags: + - server_sku + /server_skus/{id}/enable: + post: + description: 执行操作Enable + operationId: server_sku_PerformEnable + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformEnableOutput' + summary: 启用资源 + tags: + - server_sku + /server_skus/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: server_sku_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - server_sku + /server_skus/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: server_sku_PerformSetClassMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - server_sku + /server_skus/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: server_sku_PerformSetUserMetadata + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - server_sku + /server_skus/{id}/status: + get: + description: 获取指定信息Status + operationId: server_sku_GetDetailsStatus + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_sku_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - server_sku + post: + description: 执行操作Status + operationId: server_sku_PerformStatus + parameters: + - description: The Id or Name of server_sku + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformStatusOutput' + summary: 更新资源状态 + tags: + - server_sku + /server_skus/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: server_sku_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - server_sku + /server_skus/instance-specs: + get: + description: 获取指定资源类的信息InstanceSpecs + operationId: server_sku_GetPropertyInstanceSpecs + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyInstanceSpecsOutput' + summary: 获取指定资源类的信息InstanceSpecs + tags: + - server_sku + /server_skus/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: server_sku_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - server_sku + /server_skus/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: server_sku_GetPropertySplitable + responses: + "200": + $ref: '#/responses/server_sku_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - server_sku + /server_skus/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: server_sku_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/server_sku_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - server_sku + /server_skus/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: server_sku_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - server_sku + /server_skus/sync-skus: + post: + description: 执行操作SyncSkus + operationId: server_sku_PerformSyncSkus + parameters: + - in: body + name: body + schema: + properties: + server_sku: + $ref: '#/definitions/SkuSyncInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_sku_PerformSyncSkusOutput' + summary: 执行操作SyncSkus + tags: + - server_sku + /server_skus/sync-tasks: + get: + description: 获取指定资源类的信息SyncTasks + operationId: server_sku_GetPropertySyncTasks + parameters: + - description: 异步任务ID + in: query + items: + type: string + name: task_ids + type: array + x-go-name: TaskIds + responses: + "200": + $ref: '#/responses/server_sku_GetPropertySyncTasksOutput' + summary: 获取指定资源类的信息SyncTasks + tags: + - server_sku + /server_skus/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: server_sku_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - server_sku + /server_skus/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: server_sku_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/server_sku_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - server_sku + /servers: + get: + description: 列表 + operationId: server_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 是否禁止删除 + in: query + name: disable_delete + type: boolean + x-go-name: DisableDelete + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - description: 以宿主机序列号过滤 + in: query + name: host_sn + type: string + x-go-name: HostSN + - description: 以宿主机名称排序 + in: query + name: order_by_host + type: string + x-go-name: OrderByHost + - description: 以宿主机序列号名称排序 + in: query + name: order_by_host_sn + type: string + x-go-name: OrderByHostSN + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 二层网络(ID或Name)的资源 + in: query + name: wire_id + type: string + x-go-name: WireId + - description: 以二层网络名称排序 + in: query + name: order_by_wire + type: string + x-go-name: OrderByWire + - description: IP子网（ID或Name） + in: query + name: network_id + type: string + x-go-name: NetworkId + - description: 以IP子网的名称排序 + in: query + name: order_by_network + type: string + x-go-name: OrderByNetwork + - description: 计费类型，按需计费和预付费 + in: query + name: billing_type + pattern: prepaid|postpaid + type: string + x-go-name: BillingType + - description: 计费过期时间的查询起始时间 + format: date-time + in: query + name: billing_expire_since + type: string + x-go-name: BillingExpireSince + - description: 计费过期时间的查询终止时间 + format: date-time + in: query + name: billing_expire_before + type: string + x-go-name: BillingExpireBefore + - description: 计费周期 + example: 7d + in: query + name: billing_cycle + type: string + x-go-name: BillingCycle + - description: 实例组（ID或Name） + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 按组名排序 + in: query + name: order_by_group + type: string + x-go-name: OrderByGroup + - description: 过滤关联指定安全组（ID或Name）的列表结果 + in: query + name: secgroup_id + type: string + x-go-name: SecgroupId + - description: 模糊匹配安全组规则名称 + in: query + name: secgroup_name + type: string + x-go-name: SecgroupName + - description: 以安全组排序 + in: query + name: order_by_secgroup + type: string + x-go-name: OrderBySecgroup + - description: 'description: 伸缩组 Id or Name' + example: sg-1234 + in: query + name: scaling_group + type: string + x-go-name: ScalingGroup + - description: 只列出裸金属主机 + in: query + name: baremetal + type: boolean + x-go-name: Baremetal + - description: 只列出透传了 GPU 的主机 + in: query + name: gpu + type: boolean + x-go-name: Gpu + - description: 只列出透传了 USB 的主机 + in: query + name: usb + type: boolean + x-go-name: Usb + - description: 自定义 PCI 设备类型 + in: query + name: custom_dev_type + type: string + x-go-name: CustomDevType + - description: 通用虚拟机 + in: query + name: normal + type: boolean + x-go-name: Normal + - description: 只列出还有备份机的主机 + in: query + name: bakcup + type: boolean + x-go-name: Backup + - description: 列出指定类型的主机 + enum: + - normal + - gpu + - usb + - backup + in: query + name: server_type + type: string + x-go-name: ServerType + - description: 列出管理安全组为指定安全组的主机 + in: query + name: admin_security + type: string + x-go-name: AdminSecgroup + - description: 列出Hypervisor为指定值的主机 + enum: + - kvm + - esxi + - baremetal + - aliyun + - azure + - aws + - huawei + - ucloud + - zstack + - openstack + - google + - ctyun + - cloudpods + - ecloud + - jdcloud + - remotefile` + in: query + items: + type: string + name: hypervisor + type: array + x-go-name: Hypervisor + - description: 列出绑定了弹性IP（EIP）的主机 + in: query + name: with_eip + type: boolean + x-go-name: WithEip + - description: 列出未绑定弹性IP（EIP）的主机 + in: query + name: without_eip + type: boolean + x-go-name: WithoutEip + - description: 列出可绑定弹性IP的主机 + in: query + name: eip_associable + type: boolean + x-go-name: EipAssociable + - description: 列出操作系统为指定值的主机 + enum: + - linux + - windows + - vmware + in: query + items: + type: string + name: os_type + type: array + x-go-name: OsType + - description: 对列表结果按照磁盘大小进行排序 + enum: + - asc + - desc + in: query + name: order_by_disk + type: string + x-go-name: OrderByDisk + - in: query + name: order_by_ip + type: string + x-go-name: OrderByIp + - description: 根据ip查找机器 + in: query + name: ip_addr + type: string + x-go-name: IpAddr + - description: 根据多个ip查找机器 + in: query + items: + type: string + name: ip_addrs + type: array + x-go-name: IpAddrs + - description: 列出可以挂载指定EIP的主机 + in: query + name: usable_server_for_eip + type: string + x-go-name: UsableServerForEip + - description: 列出可以挂载磁盘的主机 + in: query + name: attachable_servers_for_disk + type: string + x-go-name: AttachableServersForDisk + - description: |- + Deprecated + 列出可以挂载磁盘的主机 + in: query + name: disk + type: string + x-go-name: Disk + - description: 按主机资源类型进行排序 + enum: + - shared + - prepaid + - dedicated + in: query + name: resource_type + type: string + x-go-name: ResourceType + - description: 返回该宿主机上的所有虚拟机，包括备份机 + in: query + name: get_all_guests_on_host + type: string + x-go-name: GetAllGuestsOnHost + - in: query + items: + format: int64 + type: integer + name: vcpu_count + type: array + x-go-name: VcpuCount + - in: query + items: + format: int64 + type: integer + name: vmem_size + type: array + x-go-name: VmemSize + - in: query + items: + type: string + name: boot_order + type: array + x-go-name: BootOrder + - in: query + items: + type: string + name: vga + type: array + x-go-name: Vga + - in: query + items: + type: string + name: vdi + type: array + x-go-name: Vdi + - in: query + items: + type: string + name: machine + type: array + x-go-name: Machine + - in: query + items: + type: string + name: bios + type: array + x-go-name: Bios + - in: query + name: src_ip_check + type: boolean + x-go-name: SrcIpCheck + - in: query + name: src_mac_check + type: boolean + x-go-name: SrcMacCheck + - in: query + items: + type: string + name: instance_type + type: array + x-go-name: InstanceType + - description: 是否调度到宿主机上 + in: query + name: with_host + type: boolean + x-go-name: WithHost + responses: + "200": + $ref: '#/responses/server_ListItemFilterOutput' + summary: 云主机实例列表 + tags: + - server + post: + description: 新建 + operationId: server_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + server: + $ref: '#/definitions/ServerCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_ValidateCreateDataOutput' + summary: 创建虚拟机实例 + tags: + - server + /servers/{id}: + delete: + description: 删除 + operationId: server_CustomizeDelete + parameters: + - default: false + description: 是否越过回收站直接删除 + in: query + name: OverridePendingDelete + type: boolean + - default: false + description: 是否仅删除本地资源 + in: query + name: Purge + type: boolean + - default: false + description: 是否删除快照 + in: query + name: DeleteSnapshots + type: boolean + - default: false + description: 是否删除关联的EIP + in: query + name: DeleteEip + type: boolean + - default: false + description: 是否删除关联的数据盘 + in: query + name: DeleteDisks + type: boolean + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_CustomizeDeleteOutput' + summary: 删除虚拟机 + tags: + - server + get: + description: 获取详情 + operationId: server_FetchCustomizeColumns + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - server + put: + description: 更新 + operationId: server_ValidateUpdateData + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_ValidateUpdateDataOutput' + summary: 更新 + tags: + - server + /servers/{id}/add-secgroup: + post: + description: 执行操作AddSecgroup + operationId: server_PerformAddSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestAddSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAddSecgroupOutput' + summary: 绑定多个安全组 + tags: + - server + /servers/{id}/assign-admin-secgroup: + post: + description: 执行操作AssignAdminSecgroup + operationId: server_PerformAssignAdminSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestAssignSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAssignAdminSecgroupOutput' + summary: 执行操作AssignAdminSecgroup + tags: + - server + /servers/{id}/associate-eip: + post: + description: 执行操作AssociateEip + operationId: server_PerformAssociateEip + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerAssociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAssociateEipOutput' + summary: 执行操作AssociateEip + tags: + - server + /servers/{id}/attach-isolated-device: + post: + description: 执行操作AttachIsolatedDevice + operationId: server_PerformAttachIsolatedDevice + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformAttachIsolatedDeviceOutput' + summary: 执行操作AttachIsolatedDevice + tags: + - server + /servers/{id}/attachdisk: + post: + description: 执行操作Attachdisk + operationId: server_PerformAttachdisk + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerAttachDiskInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAttachdiskOutput' + summary: 执行操作Attachdisk + tags: + - server + /servers/{id}/attachnetwork: + post: + description: 执行操作Attachnetwork + operationId: server_PerformAttachnetwork + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/AttachNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformAttachnetworkOutput' + summary: 执行操作Attachnetwork + tags: + - server + /servers/{id}/bind-groups: + post: + description: 执行操作BindGroups + operationId: server_PerformBindGroups + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformBindGroupsOutput' + summary: 执行操作BindGroups + tags: + - server + /servers/{id}/block-mirror-ready: + post: + description: 执行操作BlockMirrorReady + operationId: server_PerformBlockMirrorReady + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformBlockMirrorReadyOutput' + summary: 执行操作BlockMirrorReady + tags: + - server + /servers/{id}/block-stream-failed: + post: + description: 执行操作BlockStreamFailed + operationId: server_PerformBlockStreamFailed + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformBlockStreamFailedOutput' + summary: 执行操作BlockStreamFailed + tags: + - server + /servers/{id}/calculate-record-checksum: + post: + description: 执行操作CalculateRecordChecksum + operationId: server_PerformCalculateRecordChecksum + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCalculateRecordChecksumOutput' + summary: 执行操作CalculateRecordChecksum + tags: + - server + /servers/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: server_PerformCancelDelete + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - server + /servers/{id}/cancel-expire: + post: + description: 执行操作CancelExpire + operationId: server_PerformCancelExpire + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCancelExpireOutput' + summary: 执行操作CancelExpire + tags: + - server + /servers/{id}/cancel-live-migrate: + post: + description: 执行操作CancelLiveMigrate + operationId: server_PerformCancelLiveMigrate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCancelLiveMigrateOutput' + summary: 执行操作CancelLiveMigrate + tags: + - server + /servers/{id}/change-bandwidth: + post: + description: 执行操作ChangeBandwidth + operationId: server_PerformChangeBandwidth + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformChangeBandwidthOutput' + summary: 执行操作ChangeBandwidth + tags: + - server + /servers/{id}/change-config: + post: + description: 执行操作ChangeConfig + operationId: server_PerformChangeConfig + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerChangeConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeConfigOutput' + summary: 执行操作ChangeConfig + tags: + - server + /servers/{id}/change-disk-storage: + post: + description: 执行操作ChangeDiskStorage + operationId: server_PerformChangeDiskStorage + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerChangeDiskStorageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeDiskStorageOutput' + summary: 执行操作ChangeDiskStorage + tags: + - server + /servers/{id}/change-ipaddr: + post: + description: |- + first detach the network, then attach a network with identity mac address but different IP configurations + TODO change IP address of a teaming NIC may fail!! + operationId: server_PerformChangeIpaddr + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformChangeIpaddrOutput' + summary: Change IPaddress of a guestnetwork + tags: + - server + /servers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: server_PerformChangeOwner + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - server + /servers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: server_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - server + /servers/{id}/change-storage: + post: + description: 执行操作ChangeStorage + operationId: server_PerformChangeStorage + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerChangeStorageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformChangeStorageOutput' + summary: 执行操作ChangeStorage + tags: + - server + /servers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: server_GetDetailsClassMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - server + post: + description: 执行操作ClassMetadata + operationId: server_PerformClassMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - server + /servers/{id}/clone: + post: + description: 执行操作Clone + operationId: server_PerformClone + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCloneOutput' + summary: 执行操作Clone + tags: + - server + /servers/{id}/close-forward: + post: + description: 执行操作CloseForward + operationId: server_PerformCloseForward + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCloseForwardOutput' + summary: 执行操作CloseForward + tags: + - server + /servers/{id}/convert: + post: + description: 执行操作Convert + operationId: server_PerformConvert + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ConvertEsxiToKvmInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformConvertOutput' + summary: 执行操作Convert + tags: + - server + /servers/{id}/convert-to-kvm: + post: + description: 执行操作ConvertToKvm + operationId: server_PerformConvertToKvm + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ConvertEsxiToKvmInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformConvertToKvmOutput' + summary: 执行操作ConvertToKvm + tags: + - server + /servers/{id}/cpuset: + post: + description: 执行操作Cpuset + operationId: server_PerformCpuset + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerCPUSetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformCpusetOutput' + summary: 执行操作Cpuset + tags: + - server + /servers/{id}/cpuset-cores: + get: + description: 获取指定信息CpusetCores + operationId: server_GetDetailsCpusetCores + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsCpusetCoresOutput' + summary: 获取指定信息CpusetCores + tags: + - server + /servers/{id}/cpuset-remove: + post: + description: 执行操作CpusetRemove + operationId: server_PerformCpusetRemove + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerCPUSetRemoveInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformCpusetRemoveOutput' + summary: 执行操作CpusetRemove + tags: + - server + /servers/{id}/create-backup: + post: + description: 执行操作CreateBackup + operationId: server_PerformCreateBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCreateBackupOutput' + summary: 执行操作CreateBackup + tags: + - server + /servers/{id}/create-eip: + post: + description: 执行操作CreateEip + operationId: server_PerformCreateEip + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerCreateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformCreateEipOutput' + summary: 执行操作CreateEip + tags: + - server + /servers/{id}/create-params: + get: + description: 获取指定信息CreateParams + operationId: server_GetDetailsCreateParams + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsCreateParamsOutput' + summary: 获取指定信息CreateParams + tags: + - server + /servers/{id}/createdisk: + post: + description: 执行操作Createdisk + operationId: server_PerformCreatedisk + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformCreatediskOutput' + summary: 执行操作Createdisk + tags: + - server + /servers/{id}/del-extra-option: + post: + description: 执行操作DelExtraOption + operationId: server_PerformDelExtraOption + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDelExtraOptionInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDelExtraOptionOutput' + summary: 执行操作DelExtraOption + tags: + - server + /servers/{id}/delete-backup: + post: + description: 执行操作DeleteBackup + operationId: server_PerformDeleteBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformDeleteBackupOutput' + summary: 执行操作DeleteBackup + tags: + - server + /servers/{id}/deploy: + post: + description: 执行操作Deploy + operationId: server_PerformDeploy + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDeployInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDeployOutput' + summary: 执行操作Deploy + tags: + - server + /servers/{id}/desc: + get: + description: 获取指定信息Desc + operationId: server_GetDetailsDesc + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsDescOutput' + summary: 获取指定信息Desc + tags: + - server + /servers/{id}/detach-isolated-device: + post: + description: 执行操作DetachIsolatedDevice + operationId: server_PerformDetachIsolatedDevice + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformDetachIsolatedDeviceOutput' + summary: 执行操作DetachIsolatedDevice + tags: + - server + /servers/{id}/detach-scaling-group: + post: + description: 执行操作DetachScalingGroup + operationId: server_PerformDetachScalingGroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/SGPerformDetachScalingGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDetachScalingGroupOutput' + summary: 执行操作DetachScalingGroup + tags: + - server + /servers/{id}/detachdisk: + post: + description: 执行操作Detachdisk + operationId: server_PerformDetachdisk + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDetachDiskInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDetachdiskOutput' + summary: 执行操作Detachdisk + tags: + - server + /servers/{id}/detachnetwork: + post: + description: 执行操作Detachnetwork + operationId: server_PerformDetachnetwork + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDetachnetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDetachnetworkOutput' + summary: 执行操作Detachnetwork + tags: + - server + /servers/{id}/dissociate-eip: + post: + description: 执行操作DissociateEip + operationId: server_PerformDissociateEip + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerDissociateEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformDissociateEipOutput' + summary: 执行操作DissociateEip + tags: + - server + /servers/{id}/ejectiso: + post: + description: 执行操作Ejectiso + operationId: server_PerformEjectiso + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformEjectisoOutput' + summary: 执行操作Ejectiso + tags: + - server + /servers/{id}/ejectvfd: + post: + description: 执行操作Ejectvfd + operationId: server_PerformEjectvfd + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerEjectVfdInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformEjectvfdOutput' + summary: 执行操作Ejectvfd + tags: + - server + /servers/{id}/enable-memclean: + post: + description: 执行操作EnableMemclean + operationId: server_PerformEnableMemclean + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformEnableMemcleanOutput' + summary: 执行操作EnableMemclean + tags: + - server + /servers/{id}/event: + post: + description: 执行操作Event + operationId: server_PerformEvent + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformEventOutput' + summary: 执行操作Event + tags: + - server + /servers/{id}/freeze: + post: + description: 执行操作Freeze + operationId: server_PerformFreeze + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformFreezeOutput' + summary: 执行操作Freeze + tags: + - server + /servers/{id}/have-agent: + post: + description: 执行操作HaveAgent + operationId: server_PerformHaveAgent + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestHaveAgentInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformHaveAgentOutput' + summary: 执行操作HaveAgent + tags: + - server + /servers/{id}/insertiso: + post: + description: 执行操作Insertiso + operationId: server_PerformInsertiso + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformInsertisoOutput' + summary: 执行操作Insertiso + tags: + - server + /servers/{id}/insertvfd: + post: + description: 执行操作Insertvfd + operationId: server_PerformInsertvfd + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerInsertVfdInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformInsertvfdOutput' + summary: 执行操作Insertvfd + tags: + - server + /servers/{id}/instance-backup: + post: + description: 执行操作InstanceBackup + operationId: server_PerformInstanceBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformInstanceBackupOutput' + summary: 执行操作InstanceBackup + tags: + - server + /servers/{id}/instance-snapshot: + post: + description: |- + 2. validate every disk manual snapshot count + 3. validate snapshot quota with disk count + operationId: server_PerformInstanceSnapshot + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerInstanceSnapshot' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformInstanceSnapshotOutput' + summary: 1. validate guest status, guest hypervisor + tags: + - server + /servers/{id}/instance-snapshot-reset: + post: + description: 执行操作InstanceSnapshotReset + operationId: server_PerformInstanceSnapshotReset + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerResetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformInstanceSnapshotResetOutput' + summary: 执行操作InstanceSnapshotReset + tags: + - server + /servers/{id}/io-throttle: + post: + description: 执行操作IoThrottle + operationId: server_PerformIoThrottle + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformIoThrottleOutput' + summary: 执行操作IoThrottle + tags: + - server + /servers/{id}/iso: + get: + description: 获取指定信息Iso + operationId: server_GetDetailsIso + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsIsoOutput' + summary: 获取指定信息Iso + tags: + - server + /servers/{id}/jnlp: + get: + description: 获取指定信息Jnlp + operationId: server_GetDetailsJnlp + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsJnlpOutput' + summary: 获取指定信息Jnlp + tags: + - server + /servers/{id}/list-forward: + post: + description: 执行操作ListForward + operationId: server_PerformListForward + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformListForwardOutput' + summary: 执行操作ListForward + tags: + - server + /servers/{id}/live-migrate: + post: + description: 执行操作LiveMigrate + operationId: server_PerformLiveMigrate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestLiveMigrateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformLiveMigrateOutput' + summary: 执行操作LiveMigrate + tags: + - server + /servers/{id}/make-sshable: + post: + description: 执行操作MakeSshable + operationId: server_PerformMakeSshable + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestMakeSshableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMakeSshableOutput' + summary: 执行操作MakeSshable + tags: + - server + /servers/{id}/make-sshable-cmd: + get: + description: 获取指定信息MakeSshableCmd + operationId: server_GetDetailsMakeSshableCmd + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsMakeSshableCmdOutput' + summary: 获取指定信息MakeSshableCmd + tags: + - server + /servers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: server_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - server + /servers/{id}/migrate: + post: + description: 执行操作Migrate + operationId: server_PerformMigrate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestMigrateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMigrateOutput' + summary: 执行操作Migrate + tags: + - server + /servers/{id}/migrate-forecast: + post: + description: 执行操作MigrateForecast + operationId: server_PerformMigrateForecast + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerMigrateForecastInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMigrateForecastOutput' + summary: 执行操作MigrateForecast + tags: + - server + /servers/{id}/migrate-network: + post: + description: 'Scenerio: the server used to be in a VPC, migrate it to a underlay + network without network interruption' + operationId: server_PerformMigrateNetwork + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerMigrateNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMigrateNetworkOutput' + summary: Migrate a server from one network to another network, without change + IP address + tags: + - server + /servers/{id}/modify-src-check: + post: + description: 执行操作ModifySrcCheck + operationId: server_PerformModifySrcCheck + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformModifySrcCheckOutput' + summary: 执行操作ModifySrcCheck + tags: + - server + /servers/{id}/monitor: + post: + description: 执行操作Monitor + operationId: server_PerformMonitor + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerMonitorInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformMonitorOutput' + summary: 执行操作Monitor + tags: + - server + /servers/{id}/open-forward: + post: + description: 执行操作OpenForward + operationId: server_PerformOpenForward + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformOpenForwardOutput' + summary: 执行操作OpenForward + tags: + - server + /servers/{id}/postpaid-expire: + post: + description: 执行操作PostpaidExpire + operationId: server_PerformPostpaidExpire + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PostpaidExpireInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformPostpaidExpireOutput' + summary: 执行操作PostpaidExpire + tags: + - server + /servers/{id}/prepaid-recycle: + post: + description: 执行操作PrepaidRecycle + operationId: server_PerformPrepaidRecycle + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformPrepaidRecycleOutput' + summary: 执行操作PrepaidRecycle + tags: + - server + /servers/{id}/probe-isolated-devices: + post: + description: 执行操作ProbeIsolatedDevices + operationId: server_PerformProbeIsolatedDevices + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformProbeIsolatedDevicesOutput' + summary: 执行操作ProbeIsolatedDevices + tags: + - server + /servers/{id}/publicip-to-eip: + post: + description: |- + 要求虚拟机有公网IP,并且虚拟机状态为running 或 ready + 目前仅支持阿里云和腾讯云 + operationId: server_PerformPublicipToEip + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestPublicipToEipInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformPublicipToEipOutput' + summary: 公网Ip转Eip + tags: + - server + /servers/{id}/purge: + post: + description: 执行操作Purge + operationId: server_PerformPurge + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - server + /servers/{id}/qemu-info: + get: + description: 获取指定信息QemuInfo + operationId: server_GetDetailsQemuInfo + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsQemuInfoOutput' + summary: 获取指定信息QemuInfo + tags: + - server + /servers/{id}/qga-command: + post: + description: 执行操作QgaCommand + operationId: server_PerformQgaCommand + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerQgaCommandInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformQgaCommandOutput' + summary: 执行操作QgaCommand + tags: + - server + /servers/{id}/qga-set-password: + post: + description: 执行操作QgaSetPassword + operationId: server_PerformQgaSetPassword + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerQgaSetPasswordInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformQgaSetPasswordOutput' + summary: 执行操作QgaSetPassword + tags: + - server + /servers/{id}/rebuild-root: + post: + description: 执行操作RebuildRoot + operationId: server_PerformRebuildRoot + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerRebuildRootInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformRebuildRootOutput' + summary: 重装系统(更换系统镜像) + tags: + - server + /servers/{id}/remote-nics: + get: + description: 获取指定信息RemoteNics + operationId: server_GetDetailsRemoteNics + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsRemoteNicsOutput' + summary: 获取指定信息RemoteNics + tags: + - server + /servers/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: server_PerformRemoteUpdate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - server + /servers/{id}/renew: + post: + description: 执行操作Renew + operationId: server_PerformRenew + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformRenewOutput' + summary: 执行操作Renew + tags: + - server + /servers/{id}/reset: + post: + description: 执行操作Reset + operationId: server_PerformReset + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformResetOutput' + summary: 执行操作Reset + tags: + - server + /servers/{id}/resize-disk: + post: + description: 执行操作ResizeDisk + operationId: server_PerformResizeDisk + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerResizeDiskInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformResizeDiskOutput' + summary: 执行操作ResizeDisk + tags: + - server + /servers/{id}/restart: + post: + description: 执行操作Restart + operationId: server_PerformRestart + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformRestartOutput' + summary: 执行操作Restart + tags: + - server + /servers/{id}/resume: + post: + description: 执行操作Resume + operationId: server_PerformResume + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerResumeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformResumeOutput' + summary: 执行操作Resume + tags: + - server + /servers/{id}/revoke-admin-secgroup: + post: + description: 执行操作RevokeAdminSecgroup + operationId: server_PerformRevokeAdminSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestRevokeSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformRevokeAdminSecgroupOutput' + summary: 执行操作RevokeAdminSecgroup + tags: + - server + /servers/{id}/revoke-secgroup: + post: + description: 执行操作RevokeSecgroup + operationId: server_PerformRevokeSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestRevokeSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformRevokeSecgroupOutput' + summary: 执行操作RevokeSecgroup + tags: + - server + /servers/{id}/save-guest-image: + post: + description: 执行操作SaveGuestImage + operationId: server_PerformSaveGuestImage + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSaveGuestImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSaveGuestImageOutput' + summary: 执行操作SaveGuestImage + tags: + - server + /servers/{id}/save-image: + post: + description: 执行操作SaveImage + operationId: server_PerformSaveImage + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSaveImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSaveImageOutput' + summary: 执行操作SaveImage + tags: + - server + /servers/{id}/save-template: + post: + description: 执行操作SaveTemplate + operationId: server_PerformSaveTemplate + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestSaveToTemplateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSaveTemplateOutput' + summary: 执行操作SaveTemplate + tags: + - server + /servers/{id}/sendkeys: + post: + description: 执行操作Sendkeys + operationId: server_PerformSendkeys + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSendkeysOutput' + summary: 执行操作Sendkeys + tags: + - server + /servers/{id}/set-auto-renew: + post: + description: |- + 要求虚拟机状态为running 或 ready + 要求虚拟机计费类型为包年包月(预付费) + operationId: server_PerformSetAutoRenew + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestAutoRenewInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetAutoRenewOutput' + summary: 设置自动续费 + tags: + - server + /servers/{id}/set-boot-index: + post: + description: 执行操作SetBootIndex + operationId: server_PerformSetBootIndex + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetBootIndexInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetBootIndexOutput' + summary: 执行操作SetBootIndex + tags: + - server + /servers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: server_PerformSetClassMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - server + /servers/{id}/set-extra-option: + post: + description: 执行操作SetExtraOption + operationId: server_PerformSetExtraOption + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetExtraOptionInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetExtraOptionOutput' + summary: 执行操作SetExtraOption + tags: + - server + /servers/{id}/set-isolated-device: + post: + description: 执行操作SetIsolatedDevice + operationId: server_PerformSetIsolatedDevice + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSetIsolatedDeviceOutput' + summary: 执行操作SetIsolatedDevice + tags: + - server + /servers/{id}/set-live-migrate-params: + post: + description: 执行操作SetLiveMigrateParams + operationId: server_PerformSetLiveMigrateParams + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetLiveMigrateParamsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetLiveMigrateParamsOutput' + summary: 执行操作SetLiveMigrateParams + tags: + - server + /servers/{id}/set-password: + post: + description: 执行操作SetPassword + operationId: server_PerformSetPassword + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSetPasswordInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetPasswordOutput' + summary: 执行操作SetPassword + tags: + - server + /servers/{id}/set-qemu-params: + post: + description: 执行操作SetQemuParams + operationId: server_PerformSetQemuParams + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSetQemuParamsOutput' + summary: 执行操作SetQemuParams + tags: + - server + /servers/{id}/set-secgroup: + post: + description: 执行操作SetSecgroup + operationId: server_PerformSetSecgroup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestSetSecgroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetSecgroupOutput' + summary: 全量覆盖安全组 + tags: + - server + /servers/{id}/set-sshport: + post: + description: 执行操作SetSshport + operationId: server_PerformSetSshport + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestSetSshportInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetSshportOutput' + summary: 执行操作SetSshport + tags: + - server + /servers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: server_PerformSetUserMetadata + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - server + /servers/{id}/slave-block-stream-ready: + post: + description: 执行操作SlaveBlockStreamReady + operationId: server_PerformSlaveBlockStreamReady + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSlaveBlockStreamReadyOutput' + summary: 执行操作SlaveBlockStreamReady + tags: + - server + /servers/{id}/snapshot-and-clone: + post: + description: 执行操作SnapshotAndClone + operationId: server_PerformSnapshotAndClone + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerSnapshotAndCloneInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSnapshotAndCloneOutput' + summary: 执行操作SnapshotAndClone + tags: + - server + /servers/{id}/sshable: + get: + description: 获取指定信息Sshable + operationId: server_GetDetailsSshable + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsSshableOutput' + summary: 获取指定信息Sshable + tags: + - server + /servers/{id}/sshport: + get: + description: 获取指定信息Sshport + operationId: server_GetDetailsSshport + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsSshportOutput' + summary: 获取指定信息Sshport + tags: + - server + /servers/{id}/start: + post: + description: 执行操作Start + operationId: server_PerformStart + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformStartOutput' + summary: 执行操作Start + tags: + - server + /servers/{id}/start-backup: + post: + description: 执行操作StartBackup + operationId: server_PerformStartBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformStartBackupOutput' + summary: 执行操作StartBackup + tags: + - server + /servers/{id}/status: + get: + description: 获取指定信息Status + operationId: server_GetDetailsStatus + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - server + post: + description: 执行操作Status + operationId: server_PerformStatus + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformStatusOutput' + summary: 执行操作Status + tags: + - server + /servers/{id}/stop: + post: + description: 执行操作Stop + operationId: server_PerformStop + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerStopInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformStopOutput' + summary: 执行操作Stop + tags: + - server + /servers/{id}/stream-disks-complete: + post: + description: 执行操作StreamDisksComplete + operationId: server_PerformStreamDisksComplete + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformStreamDisksCompleteOutput' + summary: 执行操作StreamDisksComplete + tags: + - server + /servers/{id}/suspend: + post: + description: 执行操作Suspend + operationId: server_PerformSuspend + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSuspendOutput' + summary: 执行操作Suspend + tags: + - server + /servers/{id}/switch-to-backup: + post: + description: 执行操作SwitchToBackup + operationId: server_PerformSwitchToBackup + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSwitchToBackupOutput' + summary: 执行操作SwitchToBackup + tags: + - server + /servers/{id}/sync: + post: + description: 执行操作Sync + operationId: server_PerformSync + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSyncOutput' + summary: 执行操作Sync + tags: + - server + /servers/{id}/sync-fix-nics: + post: + description: 执行操作SyncFixNics + operationId: server_PerformSyncFixNics + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/GuestSyncFixNicsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformSyncFixNicsOutput' + summary: 执行操作SyncFixNics + tags: + - server + /servers/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: server_PerformSyncstatus + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformSyncstatusOutput' + summary: 同步虚拟机状态 + tags: + - server + /servers/{id}/tasks: + get: + description: 获取指定信息Tasks + operationId: server_GetDetailsTasks + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsTasksOutput' + summary: 获取指定信息Tasks + tags: + - server + /servers/{id}/unbind-groups: + post: + description: 执行操作UnbindGroups + operationId: server_PerformUnbindGroups + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformUnbindGroupsOutput' + summary: 执行操作UnbindGroups + tags: + - server + /servers/{id}/undo-prepaid-recycle: + post: + description: 执行操作UndoPrepaidRecycle + operationId: server_PerformUndoPrepaidRecycle + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_PerformUndoPrepaidRecycleOutput' + summary: 执行操作UndoPrepaidRecycle + tags: + - server + /servers/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: server_PerformUnfreeze + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - server + /servers/{id}/user-data: + post: + description: 执行操作UserData + operationId: server_PerformUserData + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/ServerUserDataInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformUserDataOutput' + summary: 执行操作UserData + tags: + - server + /servers/{id}/virt-install: + get: + description: 获取指定信息VirtInstall + operationId: server_GetDetailsVirtInstall + parameters: + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsVirtInstallOutput' + summary: 获取指定信息VirtInstall + tags: + - server + /servers/{id}/vnc: + get: + description: 获取指定信息Vnc + operationId: server_GetDetailsVnc + parameters: + - default: false + description: 是否使用原生vnc控制台，此选项仅对openstack有效 + in: query + name: origin + type: boolean + x-go-name: Origin + - description: The Id or Name of server + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/server_GetDetailsVncOutput' + summary: 获取指定信息Vnc + tags: + - server + /servers/batch-migrate: + post: + description: 执行操作BatchMigrate + operationId: server_PerformBatchMigrate + responses: + "200": + $ref: '#/responses/server_PerformBatchMigrateOutput' + summary: 执行操作BatchMigrate + tags: + - server + /servers/batch-set-user-metadata: + post: + description: 执行操作BatchSetUserMetadata + operationId: server_PerformBatchSetUserMetadata + responses: + "200": + $ref: '#/responses/server_PerformBatchSetUserMetadataOutput' + summary: 执行操作BatchSetUserMetadata + tags: + - server + /servers/batch-user-metadata: + post: + description: 执行操作BatchUserMetadata + operationId: server_PerformBatchUserMetadata + responses: + "200": + $ref: '#/responses/server_PerformBatchUserMetadataOutput' + summary: 执行操作BatchUserMetadata + tags: + - server + /servers/dirty-server-start: + post: + description: 执行操作DirtyServerStart + operationId: server_PerformDirtyServerStart + responses: + "200": + $ref: '#/responses/server_PerformDirtyServerStartOutput' + summary: 执行操作DirtyServerStart + tags: + - server + /servers/dirty-server-verify: + post: + description: 执行操作DirtyServerVerify + operationId: server_PerformDirtyServerVerify + responses: + "200": + $ref: '#/responses/server_PerformDirtyServerVerifyOutput' + summary: 执行操作DirtyServerVerify + tags: + - server + /servers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: server_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/server_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - server + /servers/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: server_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/server_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - server + /servers/import: + post: + description: 执行操作Import + operationId: server_PerformImport + responses: + "200": + $ref: '#/responses/server_PerformImportOutput' + summary: 执行操作Import + tags: + - server + /servers/import-from-libvirt: + post: + description: 执行操作ImportFromLibvirt + operationId: server_PerformImportFromLibvirt + responses: + "200": + $ref: '#/responses/server_PerformImportFromLibvirtOutput' + summary: 执行操作ImportFromLibvirt + tags: + - server + /servers/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: server_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/server_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - server + /servers/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: server_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/server_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - server + /servers/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: server_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/server_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - server + /servers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: server_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + server: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/server_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - server + /servers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: server_GetPropertySplitable + responses: + "200": + $ref: '#/responses/server_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - server + /servers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: server_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/server_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - server + /servers/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: server_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/server_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - server + /servers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: server_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/server_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - server + /servers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: server_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/server_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - server + /service_catalogs: + get: + description: 列表 + operationId: service_catalog_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 主机镜像 + in: query + name: guest_template_id + type: string + x-go-name: GuestTemplateId + responses: + "200": + $ref: '#/responses/service_catalog_ListItemFilterOutput' + summary: 服务目录列表 + tags: + - service_catalog + post: + description: 新建 + operationId: service_catalog_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + service_catalog: + $ref: '#/definitions/ServiceCatalogCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_ValidateCreateDataOutput' + summary: 新建 + tags: + - service_catalog + /service_catalogs/{id}: + delete: + description: 删除 + operationId: service_catalog_CustomizeDelete + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_CustomizeDeleteOutput' + summary: 删除 + tags: + - service_catalog + get: + description: 获取详情 + operationId: service_catalog_FetchCustomizeColumns + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - service_catalog + put: + description: 更新 + operationId: service_catalog_ValidateUpdateData + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_ValidateUpdateDataOutput' + summary: 更新 + tags: + - service_catalog + /service_catalogs/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: service_catalog_PerformCancelDelete + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - service_catalog + /service_catalogs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: service_catalog_PerformChangeOwner + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - service_catalog + /service_catalogs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: service_catalog_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - service_catalog + /service_catalogs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: service_catalog_GetDetailsClassMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - service_catalog + post: + description: 执行操作ClassMetadata + operationId: service_catalog_PerformClassMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - service_catalog + /service_catalogs/{id}/deploy: + post: + description: 执行操作Deploy + operationId: service_catalog_PerformDeploy + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDeploy' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformDeployOutput' + summary: 执行操作Deploy + tags: + - service_catalog + /service_catalogs/{id}/freeze: + post: + description: 执行操作Freeze + operationId: service_catalog_PerformFreeze + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - service_catalog + /service_catalogs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: service_catalog_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - service_catalog + /service_catalogs/{id}/private: + post: + description: 执行操作Private + operationId: service_catalog_PerformPrivate + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformPrivateOutput' + summary: 执行操作Private + tags: + - service_catalog + /service_catalogs/{id}/public: + post: + description: 执行操作Public + operationId: service_catalog_PerformPublic + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformPublicOutput' + summary: 执行操作Public + tags: + - service_catalog + /service_catalogs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: service_catalog_PerformSetClassMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - service_catalog + /service_catalogs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: service_catalog_PerformSetUserMetadata + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - service_catalog + /service_catalogs/{id}/status: + get: + description: 获取指定信息Status + operationId: service_catalog_GetDetailsStatus + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_catalog_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - service_catalog + post: + description: 执行操作Status + operationId: service_catalog_PerformStatus + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformStatusOutput' + summary: 更新资源状态 + tags: + - service_catalog + /service_catalogs/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: service_catalog_PerformUnfreeze + parameters: + - description: The Id or Name of service_catalog + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - service_catalog + /service_catalogs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: service_catalog_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - service_catalog + /service_catalogs/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: service_catalog_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - service_catalog + /service_catalogs/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: service_catalog_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - service_catalog + /service_catalogs/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: service_catalog_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - service_catalog + /service_catalogs/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: service_catalog_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - service_catalog + /service_catalogs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: service_catalog_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + service_catalog: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_catalog_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - service_catalog + /service_catalogs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: service_catalog_GetPropertySplitable + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - service_catalog + /service_catalogs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: service_catalog_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - service_catalog + /service_catalogs/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: service_catalog_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - service_catalog + /service_catalogs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: service_catalog_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - service_catalog + /service_catalogs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: service_catalog_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/service_catalog_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - service_catalog + /snapshot_policies: + get: + description: 列表 + operationId: snapshot_policy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 按绑定的磁盘数量排序 + in: query + name: order_by_bind_disk_count + pattern: asc|desc + type: string + x-go-name: OrderByBindDiskCount + - description: 是否启用？ + in: query + name: is_activated + type: boolean + x-go-name: IsActivated + responses: + "200": + $ref: '#/responses/snapshot_policy_ListItemFilterOutput' + summary: 快照策略列表 + tags: + - snapshot_policy + post: + description: 新建 + operationId: snapshot_policy_ValidateCreateData + responses: + "200": + $ref: '#/responses/snapshot_policy_ValidateCreateDataOutput' + summary: 新建 + tags: + - snapshot_policy + /snapshot_policies/{id}: + delete: + description: 删除 + operationId: snapshot_policy_CustomizeDelete + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_CustomizeDeleteOutput' + summary: 删除 + tags: + - snapshot_policy + get: + description: 获取详情 + operationId: snapshot_policy_FetchCustomizeColumns + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - snapshot_policy + put: + description: 更新 + operationId: snapshot_policy_ValidateUpdateData + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - snapshot_policy + /snapshot_policies/{id}/bind-disks: + post: + description: 执行操作BindDisks + operationId: snapshot_policy_PerformBindDisks + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformBindDisksOutput' + summary: 执行操作BindDisks + tags: + - snapshot_policy + /snapshot_policies/{id}/cache: + post: + description: 执行操作Cache + operationId: snapshot_policy_PerformCache + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformCacheOutput' + summary: 执行操作Cache + tags: + - snapshot_policy + /snapshot_policies/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: snapshot_policy_PerformCancelDelete + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - snapshot_policy + /snapshot_policies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: snapshot_policy_PerformChangeOwner + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - snapshot_policy + /snapshot_policies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: snapshot_policy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - snapshot_policy + /snapshot_policies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: snapshot_policy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - snapshot_policy + post: + description: 执行操作ClassMetadata + operationId: snapshot_policy_PerformClassMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - snapshot_policy + /snapshot_policies/{id}/freeze: + post: + description: 执行操作Freeze + operationId: snapshot_policy_PerformFreeze + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - snapshot_policy + /snapshot_policies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: snapshot_policy_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - snapshot_policy + /snapshot_policies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: snapshot_policy_PerformSetClassMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - snapshot_policy + /snapshot_policies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: snapshot_policy_PerformSetUserMetadata + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - snapshot_policy + /snapshot_policies/{id}/status: + get: + description: 获取指定信息Status + operationId: snapshot_policy_GetDetailsStatus + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - snapshot_policy + post: + description: 执行操作Status + operationId: snapshot_policy_PerformStatus + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformStatusOutput' + summary: 更新资源状态 + tags: + - snapshot_policy + /snapshot_policies/{id}/unbind-disks: + post: + description: 执行操作UnbindDisks + operationId: snapshot_policy_PerformUnbindDisks + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformUnbindDisksOutput' + summary: 执行操作UnbindDisks + tags: + - snapshot_policy + /snapshot_policies/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: snapshot_policy_PerformUnfreeze + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - snapshot_policy + /snapshot_policies/{id}/update: + post: + description: 执行操作Update + operationId: snapshot_policy_PerformUpdate + parameters: + - description: The Id or Name of snapshot_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformUpdateOutput' + summary: 执行操作Update + tags: + - snapshot_policy + /snapshot_policies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: snapshot_policy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - snapshot_policy + /snapshot_policies/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: snapshot_policy_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - snapshot_policy + /snapshot_policies/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: snapshot_policy_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - snapshot_policy + /snapshot_policies/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: snapshot_policy_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - snapshot_policy + /snapshot_policies/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: snapshot_policy_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - snapshot_policy + /snapshot_policies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: snapshot_policy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + snapshot_policy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - snapshot_policy + /snapshot_policies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: snapshot_policy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - snapshot_policy + /snapshot_policies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: snapshot_policy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - snapshot_policy + /snapshot_policies/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: snapshot_policy_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - snapshot_policy + /snapshot_policies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: snapshot_policy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - snapshot_policy + /snapshot_policies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: snapshot_policy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_policy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - snapshot_policy + /snapshot_policy_caches: + get: + description: 列表 + operationId: snapshot_policy_cache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: filter disk by snapshotpolicy + in: query + name: snapshotpolicy_id + type: string + x-go-name: SnapshotpolicyId + - description: 以快照策略名称排序 + in: query + name: order_by_snapshotpolicy + type: string + x-go-name: OrderBySnapshotpolicy + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_ListItemFilterOutput' + summary: 快照策略缓存列表 + tags: + - snapshot_policy_cache + post: + description: 新建 + operationId: snapshot_policy_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + snapshot_policy_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - snapshot_policy_cache + /snapshot_policy_caches/{id}: + delete: + description: 删除 + operationId: snapshot_policy_cache_CustomizeDelete + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - snapshot_policy_cache + get: + description: 获取详情 + operationId: snapshot_policy_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - snapshot_policy_cache + put: + description: 更新 + operationId: snapshot_policy_cache_ValidateUpdateData + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - snapshot_policy_cache + /snapshot_policy_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: snapshot_policy_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - snapshot_policy_cache + post: + description: 执行操作ClassMetadata + operationId: snapshot_policy_cache_PerformClassMetadata + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - snapshot_policy_cache + /snapshot_policy_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: snapshot_policy_cache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - snapshot_policy_cache + /snapshot_policy_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: snapshot_policy_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - snapshot_policy_cache + /snapshot_policy_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: snapshot_policy_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - snapshot_policy_cache + /snapshot_policy_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: snapshot_policy_cache_GetDetailsStatus + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - snapshot_policy_cache + post: + description: 执行操作Status + operationId: snapshot_policy_cache_PerformStatus + parameters: + - description: The Id or Name of snapshot_policy_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - snapshot_policy_cache + /snapshot_policy_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: snapshot_policy_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - snapshot_policy_cache + /snapshot_policy_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: snapshot_policy_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - snapshot_policy_cache + /snapshot_policy_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: snapshot_policy_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - snapshot_policy_cache + /snapshot_policy_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: snapshot_policy_cache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - snapshot_policy_cache + /snapshot_policy_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: snapshot_policy_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - snapshot_policy_cache + /snapshot_policy_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: snapshot_policy_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - snapshot_policy_cache + /snapshot_policy_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: snapshot_policy_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_policy_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - snapshot_policy_cache + /snapshot_policy_disks: + get: + description: 列表 + operationId: snapshot_policy_disk_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: filter disk by snapshotpolicy + in: query + name: snapshotpolicy_id + type: string + x-go-name: SnapshotpolicyId + - description: 以快照策略名称排序 + in: query + name: order_by_snapshotpolicy + type: string + x-go-name: OrderBySnapshotpolicy + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 虚拟磁盘（ID或Name） + in: query + name: disk_id + type: string + x-go-name: DiskId + - description: 以磁盘名称排序 + in: query + name: order_by_disk + pattern: asc|desc + type: string + x-go-name: OrderByDisk + - description: 状态 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_ListItemFilterOutput' + summary: 列表 + tags: + - snapshot_policy_disk + post: + description: 新建 + operationId: snapshot_policy_disk_ValidateCreateData + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_ValidateCreateDataOutput' + summary: 新建 + tags: + - snapshot_policy_disk + /snapshot_policy_disks/{id}: + delete: + description: 删除 + operationId: snapshot_policy_disk_CustomizeDelete + parameters: + - description: The Id or Name of snapshot_policy_disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_CustomizeDeleteOutput' + summary: 删除 + tags: + - snapshot_policy_disk + get: + description: 获取详情 + operationId: snapshot_policy_disk_FetchCustomizeColumns + parameters: + - description: The Id or Name of snapshot_policy_disk + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - snapshot_policy_disk + put: + description: 更新 + operationId: snapshot_policy_disk_ValidateUpdateData + parameters: + - description: The Id or Name of snapshot_policy_disk + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_ValidateUpdateDataOutput' + summary: 更新 + tags: + - snapshot_policy_disk + /snapshot_policy_disks/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: snapshot_policy_disk_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - snapshot_policy_disk + /snapshot_policy_disks/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: snapshot_policy_disk_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - snapshot_policy_disk + /snapshot_policy_disks/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: snapshot_policy_disk_GetPropertySplitable + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - snapshot_policy_disk + /snapshot_policy_disks/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: snapshot_policy_disk_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/snapshot_policy_disk_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - snapshot_policy_disk + /snapshots: + get: + description: 列表 + operationId: snapshot_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: 虚拟磁盘（ID或Name） + in: query + name: disk_id + type: string + x-go-name: DiskId + - description: 以磁盘名称排序 + in: query + name: order_by_disk + pattern: asc|desc + type: string + x-go-name: OrderByDisk + - description: 存储（ID或Name） + in: query + name: storage_id + type: string + x-go-name: StorageId + - description: 以存储名称排序 + in: query + name: order_by_storage + pattern: asc|desc + type: string + x-go-name: OrderByStorage + - description: filter snapshot that is fake deleted + in: query + name: fake_deleted + type: boolean + x-go-name: FakeDeleted + - description: filter by disk type + in: query + name: disk_type + type: string + x-go-name: DiskType + - description: filter instance snapshot + in: query + name: is_instance_snapshot + type: boolean + x-go-name: IsInstanceSnapshot + - in: query + name: out_of_chain + type: boolean + x-go-name: OutOfChain + - in: query + items: + type: string + name: os_type + type: array + x-go-name: OsType + - description: list server snapshots + in: query + name: server_id + type: string + x-go-name: ServerId + - description: 按虚拟机名称排序 + in: query + name: order_by_guest + pattern: asc|desc + type: string + x-go-name: OrderByGuest + - description: 按磁盘名称排序 + in: query + name: order_by_disk_name + pattern: asc|desc + type: string + x-go-name: OrderByDiskName + responses: + "200": + $ref: '#/responses/snapshot_ListItemFilterOutput' + summary: 快照列表 + tags: + - snapshot + post: + description: 新建 + operationId: snapshot_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + snapshot: + $ref: '#/definitions/SnapshotCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_ValidateCreateDataOutput' + summary: 新建 + tags: + - snapshot + /snapshots/{id}: + delete: + description: 删除 + operationId: snapshot_CustomizeDelete + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_CustomizeDeleteOutput' + summary: 删除 + tags: + - snapshot + get: + description: 获取详情 + operationId: snapshot_FetchCustomizeColumns + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - snapshot + put: + description: 更新 + operationId: snapshot_ValidateUpdateData + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_ValidateUpdateDataOutput' + summary: 更新 + tags: + - snapshot + /snapshots/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: snapshot_PerformCancelDelete + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - snapshot + /snapshots/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: snapshot_PerformChangeOwner + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - snapshot + /snapshots/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: snapshot_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - snapshot + /snapshots/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: snapshot_GetDetailsClassMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - snapshot + post: + description: 执行操作ClassMetadata + operationId: snapshot_PerformClassMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - snapshot + /snapshots/{id}/deleted: + post: + description: 执行操作Deleted + operationId: snapshot_PerformDeleted + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_PerformDeletedOutput' + summary: 执行操作Deleted + tags: + - snapshot + /snapshots/{id}/freeze: + post: + description: 执行操作Freeze + operationId: snapshot_PerformFreeze + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - snapshot + /snapshots/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: snapshot_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - snapshot + /snapshots/{id}/purge: + post: + description: 执行操作Purge + operationId: snapshot_PerformPurge + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - snapshot + /snapshots/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: snapshot_PerformSetClassMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - snapshot + /snapshots/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: snapshot_PerformSetUserMetadata + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - snapshot + /snapshots/{id}/status: + get: + description: 获取指定信息Status + operationId: snapshot_GetDetailsStatus + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/snapshot_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - snapshot + post: + description: 执行操作Status + operationId: snapshot_PerformStatus + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformStatusOutput' + summary: 更新资源状态 + tags: + - snapshot + /snapshots/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: snapshot_PerformSyncstatus + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformSyncstatusOutput' + summary: 同步快照状态 + tags: + - snapshot + /snapshots/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: snapshot_PerformUnfreeze + parameters: + - description: The Id or Name of snapshot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - snapshot + /snapshots/delete-disk-snapshots: + post: + description: 执行操作DeleteDiskSnapshots + operationId: snapshot_PerformDeleteDiskSnapshots + responses: + "200": + $ref: '#/responses/snapshot_PerformDeleteDiskSnapshotsOutput' + summary: 执行操作DeleteDiskSnapshots + tags: + - snapshot + /snapshots/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: snapshot_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - snapshot + /snapshots/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: snapshot_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - snapshot + /snapshots/max-count: + get: + description: 获取指定资源类的信息MaxCount + operationId: snapshot_GetPropertyMaxCount + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyMaxCountOutput' + summary: 获取指定资源类的信息MaxCount + tags: + - snapshot + /snapshots/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: snapshot_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - snapshot + /snapshots/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: snapshot_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - snapshot + /snapshots/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: snapshot_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - snapshot + /snapshots/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: snapshot_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + snapshot: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/snapshot_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - snapshot + /snapshots/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: snapshot_GetPropertySplitable + responses: + "200": + $ref: '#/responses/snapshot_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - snapshot + /snapshots/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: snapshot_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/snapshot_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - snapshot + /snapshots/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: snapshot_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - snapshot + /snapshots/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: snapshot_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - snapshot + /snapshots/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: snapshot_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/snapshot_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - snapshot + /storagecachedimages: + get: + description: 列表 + operationId: storagecachedimage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 存储缓存（ID或Name） + in: query + name: storagecache_id + type: string + x-go-name: StoragecacheId + - description: 以存储缓存名称排序 + in: query + name: order_by_storagecache + pattern: asc|desc + type: string + x-go-name: OrderByStoragecache + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 以镜像缓存过滤 + in: query + name: cachedimage_id + type: string + x-go-name: CachedimageId + - description: 镜像状态 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/storagecachedimage_ListItemFilterOutput' + summary: 列表 + tags: + - storagecachedimage + post: + description: 新建 + operationId: storagecachedimage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + storagecachedimage: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecachedimage_ValidateCreateDataOutput' + summary: 新建 + tags: + - storagecachedimage + /storagecachedimages/{id}: + delete: + description: 删除 + operationId: storagecachedimage_CustomizeDelete + parameters: + - description: The Id or Name of storagecachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecachedimage_CustomizeDeleteOutput' + summary: 删除 + tags: + - storagecachedimage + get: + description: 获取详情 + operationId: storagecachedimage_FetchCustomizeColumns + parameters: + - description: The Id or Name of storagecachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecachedimage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - storagecachedimage + put: + description: 更新 + operationId: storagecachedimage_ValidateUpdateData + parameters: + - description: The Id or Name of storagecachedimage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecachedimage: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecachedimage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - storagecachedimage + /storagecachedimages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: storagecachedimage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/storagecachedimage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - storagecachedimage + /storagecachedimages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: storagecachedimage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + storagecachedimage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecachedimage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - storagecachedimage + /storagecachedimages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: storagecachedimage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/storagecachedimage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - storagecachedimage + /storagecachedimages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: storagecachedimage_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/storagecachedimage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - storagecachedimage + /storagecaches: + get: + description: 列表 + operationId: storagecache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 路径过滤 + in: query + items: + type: string + name: path + type: array + x-go-name: Path + responses: + "200": + $ref: '#/responses/storagecache_ListItemFilterOutput' + summary: 镜像缓存存储列表 + tags: + - storagecache + post: + description: 新建 + operationId: storagecache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + storagecache: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_ValidateCreateDataOutput' + summary: 新建 + tags: + - storagecache + /storagecaches/{id}: + delete: + description: 删除 + operationId: storagecache_CustomizeDelete + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_CustomizeDeleteOutput' + summary: 删除 + tags: + - storagecache + get: + description: 获取详情 + operationId: storagecache_FetchCustomizeColumns + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - storagecache + put: + description: 更新 + operationId: storagecache_ValidateUpdateData + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - storagecache + /storagecaches/{id}/cache-image: + post: + description: 执行操作CacheImage + operationId: storagecache_PerformCacheImage + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + $ref: '#/definitions/CacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformCacheImageOutput' + summary: 执行操作CacheImage + tags: + - storagecache + /storagecaches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: storagecache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - storagecache + post: + description: 执行操作ClassMetadata + operationId: storagecache_PerformClassMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - storagecache + /storagecaches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: storagecache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - storagecache + /storagecaches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: storagecache_PerformSetClassMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - storagecache + /storagecaches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: storagecache_PerformSetUserMetadata + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - storagecache + /storagecaches/{id}/uncache-image: + post: + description: 执行操作UncacheImage + operationId: storagecache_PerformUncacheImage + parameters: + - description: The Id or Name of storagecache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storagecache_PerformUncacheImageOutput' + summary: 执行操作UncacheImage + tags: + - storagecache + /storagecaches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: storagecache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/storagecache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - storagecache + /storagecaches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: storagecache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + storagecache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storagecache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - storagecache + /storagecaches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: storagecache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/storagecache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - storagecache + /storagecaches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: storagecache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/storagecache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - storagecache + /storagecaches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: storagecache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/storagecache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - storagecache + /storagecaches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: storagecache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/storagecache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - storagecache + /storages: + get: + description: 列表 + operationId: storage_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 以关联的调度标签（ID或Name）过滤列表 + in: query + name: schedtag_id + type: string + x-go-name: SchedtagId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter shared storage + in: query + name: share + type: boolean + x-go-name: Share + - description: filter local storage + in: query + name: local + type: boolean + x-go-name: Local + - description: filter by host schedtag + in: query + name: host_schedtag_id + type: string + x-go-name: HostSchedtagId + - description: filter by cachedimage + in: query + name: image_id + type: string + x-go-name: ImageId + - description: filter storages which attached the specified host + in: query + name: host_id + type: string + x-go-name: HostId + - description: filter storages which server can change disks to + in: query + name: server_id + type: string + x-go-name: ServerId + - description: filter storages of baremetal host + in: query + name: is_baremetal + type: boolean + x-go-name: IsBaremetal + responses: + "200": + $ref: '#/responses/storage_ListItemFilterOutput' + summary: 块存储列表 + tags: + - storage + post: + description: 新建 + operationId: storage_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + storage: + $ref: '#/definitions/StorageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_ValidateCreateDataOutput' + summary: 新建 + tags: + - storage + /storages/{id}: + delete: + description: 删除 + operationId: storage_CustomizeDelete + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_CustomizeDeleteOutput' + summary: 删除 + tags: + - storage + get: + description: 获取详情 + operationId: storage_FetchCustomizeColumns + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - storage + put: + description: 更新 + operationId: storage_ValidateUpdateData + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/StorageUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_ValidateUpdateDataOutput' + summary: 更新 + tags: + - storage + /storages/{id}/cache-image: + post: + description: 执行操作CacheImage + operationId: storage_PerformCacheImage + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/CacheImageInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformCacheImageOutput' + summary: 执行操作CacheImage + tags: + - storage + /storages/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: storage_PerformChangeOwner + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - storage + /storages/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: storage_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - storage + /storages/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: storage_GetDetailsClassMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - storage + post: + description: 执行操作ClassMetadata + operationId: storage_PerformClassMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - storage + /storages/{id}/disable: + post: + description: 执行操作Disable + operationId: storage_PerformDisable + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformDisableOutput' + summary: 执行操作Disable + tags: + - storage + /storages/{id}/enable: + post: + description: 执行操作Enable + operationId: storage_PerformEnable + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformEnableOutput' + summary: 执行操作Enable + tags: + - storage + /storages/{id}/force-detach-host: + post: + description: 执行操作ForceDetachHost + operationId: storage_PerformForceDetachHost + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/StorageForceDetachHostInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformForceDetachHostOutput' + summary: 执行操作ForceDetachHost + tags: + - storage + /storages/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: storage_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - storage + /storages/{id}/offline: + post: + description: 执行操作Offline + operationId: storage_PerformOffline + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformOfflineOutput' + summary: 执行操作Offline + tags: + - storage + /storages/{id}/online: + post: + description: 执行操作Online + operationId: storage_PerformOnline + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformOnlineOutput' + summary: 执行操作Online + tags: + - storage + /storages/{id}/private: + post: + description: 执行操作Private + operationId: storage_PerformPrivate + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformPrivateOutput' + summary: 执行操作Private + tags: + - storage + /storages/{id}/public: + post: + description: 执行操作Public + operationId: storage_PerformPublic + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformPublicOutput' + summary: 执行操作Public + tags: + - storage + /storages/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: storage_PerformSetClassMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - storage + /storages/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: storage_PerformSetSchedtag + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - storage + /storages/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: storage_PerformSetUserMetadata + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - storage + /storages/{id}/status: + get: + description: 获取指定信息Status + operationId: storage_GetDetailsStatus + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - storage + post: + description: 执行操作Status + operationId: storage_PerformStatus + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformStatusOutput' + summary: 更新资源状态 + tags: + - storage + /storages/{id}/uncache-image: + post: + description: 执行操作UncacheImage + operationId: storage_PerformUncacheImage + parameters: + - description: The Id or Name of storage + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/storage_PerformUncacheImageOutput' + summary: 执行操作UncacheImage + tags: + - storage + /storages/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: storage_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/storage_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - storage + /storages/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: storage_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/storage_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - storage + /storages/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: storage_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/storage_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - storage + /storages/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: storage_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + storage: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/storage_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - storage + /storages/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: storage_GetPropertySplitable + responses: + "200": + $ref: '#/responses/storage_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - storage + /storages/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: storage_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/storage_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - storage + /storages/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: storage_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/storage_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - storage + /storages/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: storage_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/storage_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - storage + /storages/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: storage_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/storage_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - storage + /tablestores: + get: + description: 列表 + operationId: tablestore_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + responses: + "200": + $ref: '#/responses/tablestore_ListItemFilterOutput' + summary: Tablestore列表 + tags: + - tablestore + post: + description: 新建 + operationId: tablestore_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + tablestore: + $ref: '#/definitions/TablestoreCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_ValidateCreateDataOutput' + summary: 新建 + tags: + - tablestore + /tablestores/{id}: + delete: + description: 删除 + operationId: tablestore_CustomizeDelete + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_CustomizeDeleteOutput' + summary: 删除 + tags: + - tablestore + get: + description: 获取详情 + operationId: tablestore_FetchCustomizeColumns + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - tablestore + put: + description: 更新 + operationId: tablestore_ValidateUpdateData + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_ValidateUpdateDataOutput' + summary: 更新 + tags: + - tablestore + /tablestores/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: tablestore_PerformCancelDelete + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - tablestore + /tablestores/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: tablestore_PerformChangeOwner + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - tablestore + /tablestores/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: tablestore_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - tablestore + /tablestores/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: tablestore_GetDetailsClassMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - tablestore + post: + description: 执行操作ClassMetadata + operationId: tablestore_PerformClassMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - tablestore + /tablestores/{id}/freeze: + post: + description: 执行操作Freeze + operationId: tablestore_PerformFreeze + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - tablestore + /tablestores/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: tablestore_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - tablestore + /tablestores/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: tablestore_PerformSetClassMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - tablestore + /tablestores/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: tablestore_PerformSetUserMetadata + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - tablestore + /tablestores/{id}/status: + get: + description: 获取指定信息Status + operationId: tablestore_GetDetailsStatus + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/tablestore_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - tablestore + post: + description: 执行操作Status + operationId: tablestore_PerformStatus + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformStatusOutput' + summary: 更新资源状态 + tags: + - tablestore + /tablestores/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: tablestore_PerformUnfreeze + parameters: + - description: The Id or Name of tablestore + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - tablestore + /tablestores/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: tablestore_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - tablestore + /tablestores/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: tablestore_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - tablestore + /tablestores/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: tablestore_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - tablestore + /tablestores/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: tablestore_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - tablestore + /tablestores/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: tablestore_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - tablestore + /tablestores/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: tablestore_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + tablestore: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/tablestore_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - tablestore + /tablestores/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: tablestore_GetPropertySplitable + responses: + "200": + $ref: '#/responses/tablestore_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - tablestore + /tablestores/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: tablestore_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/tablestore_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - tablestore + /tablestores/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: tablestore_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - tablestore + /tablestores/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: tablestore_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - tablestore + /tablestores/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: tablestore_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/tablestore_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - tablestore + /vpc_peering_connections: + get: + description: 列表 + operationId: vpc_peering_connection_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + name: PeerVpcId + type: string + responses: + "200": + $ref: '#/responses/vpc_peering_connection_ListItemFilterOutput' + summary: 列表 + tags: + - vpc_peering_connection + post: + description: 新建 + operationId: vpc_peering_connection_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_ValidateCreateDataOutput' + summary: 创建 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}: + delete: + description: 删除 + operationId: vpc_peering_connection_CustomizeDelete + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_CustomizeDeleteOutput' + summary: 删除 + tags: + - vpc_peering_connection + get: + description: 获取详情 + operationId: vpc_peering_connection_FetchCustomizeColumns + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - vpc_peering_connection + put: + description: 更新 + operationId: vpc_peering_connection_ValidateUpdateData + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_ValidateUpdateDataOutput' + summary: 更新 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: vpc_peering_connection_PerformChangeOwner + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: vpc_peering_connection_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: vpc_peering_connection_GetDetailsClassMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - vpc_peering_connection + post: + description: 执行操作ClassMetadata + operationId: vpc_peering_connection_PerformClassMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/disable: + post: + description: 执行操作Disable + operationId: vpc_peering_connection_PerformDisable + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformDisableOutput' + summary: 禁用资源 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/enable: + post: + description: 执行操作Enable + operationId: vpc_peering_connection_PerformEnable + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformEnableOutput' + summary: 启用资源 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: vpc_peering_connection_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/private: + post: + description: 执行操作Private + operationId: vpc_peering_connection_PerformPrivate + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformPrivateOutput' + summary: 执行操作Private + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/public: + post: + description: 执行操作Public + operationId: vpc_peering_connection_PerformPublic + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformPublicOutput' + summary: 执行操作Public + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: vpc_peering_connection_PerformSetClassMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: vpc_peering_connection_PerformSetUserMetadata + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/status: + get: + description: 获取指定信息Status + operationId: vpc_peering_connection_GetDetailsStatus + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - vpc_peering_connection + post: + description: 执行操作Status + operationId: vpc_peering_connection_PerformStatus + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformStatusOutput' + summary: 更新资源状态 + tags: + - vpc_peering_connection + /vpc_peering_connections/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: vpc_peering_connection_PerformSyncstatus + parameters: + - description: The Id or Name of vpc_peering_connection + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformSyncstatusOutput' + summary: 同步状态 + tags: + - vpc_peering_connection + /vpc_peering_connections/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: vpc_peering_connection_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - vpc_peering_connection + /vpc_peering_connections/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: vpc_peering_connection_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - vpc_peering_connection + /vpc_peering_connections/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: vpc_peering_connection_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - vpc_peering_connection + /vpc_peering_connections/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: vpc_peering_connection_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_peering_connection_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - vpc_peering_connection + /vpc_peering_connections/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: vpc_peering_connection_GetPropertySplitable + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - vpc_peering_connection + /vpc_peering_connections/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: vpc_peering_connection_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - vpc_peering_connection + /vpc_peering_connections/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: vpc_peering_connection_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - vpc_peering_connection + /vpc_peering_connections/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: vpc_peering_connection_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - vpc_peering_connection + /vpc_peering_connections/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: vpc_peering_connection_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/vpc_peering_connection_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - vpc_peering_connection + /vpcs: + get: + description: 列表 + operationId: vpc_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: GlobalVpc ID or Name + in: query + name: globalvpc_id + type: string + x-go-name: GlobalvpcId + - description: 以GlobalVpc的名称排序 + in: query + name: order_by_globalvpc + pattern: asc|desc + type: string + x-go-name: OrderByGlobalvpc + - in: query + name: dns_zone_id + type: string + x-go-name: DnsZoneId + - in: query + name: inter_vpc_network_id + type: string + x-go-name: InterVpcNetworkId + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by Vpc usability of the resource + in: query + name: usable_vpc + type: boolean + x-go-name: UsableVpc + - description: 过滤可以加入指定vpc互联的vpc + in: query + name: usable_for_inter_vpc_network_id + type: string + x-go-name: UsableForInterVpcNetworkId + - description: 过滤vpc底下有指定zone的ip子网 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: filter by globalvpc + in: query + name: globalvpc + type: string + x-go-name: Globalvpc + - description: 是否是默认VPC + example: true + in: query + name: is_default + type: boolean + x-go-name: IsDefault + - description: CIDR地址段 + example: 192.168.222.0/24 + in: query + items: + type: string + name: cidr_block + type: array + x-go-name: CidrBlock + - description: 'enmu: eip, none' + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按子网数量排序 + in: query + name: order_by_network_count + pattern: asc|desc + type: string + x-go-name: OrderByNetworkCount + - description: 按二层网络数量排序 + in: query + name: OrderByWireCount + pattern: asc|desc + type: string + responses: + "200": + $ref: '#/responses/vpc_ListItemFilterOutput' + summary: 列出VPC + tags: + - vpc + post: + description: 新建 + operationId: vpc_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + vpc: + $ref: '#/definitions/VpcCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_ValidateCreateDataOutput' + summary: 新建 + tags: + - vpc + /vpcs/{id}: + delete: + description: 删除 + operationId: vpc_CustomizeDelete + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_CustomizeDeleteOutput' + summary: 删除 + tags: + - vpc + get: + description: 获取详情 + operationId: vpc_FetchCustomizeColumns + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - vpc + put: + description: 更新 + operationId: vpc_ValidateUpdateData + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/VpcUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_ValidateUpdateDataOutput' + summary: 更新 + tags: + - vpc + /vpcs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: vpc_PerformChangeOwner + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - vpc + /vpcs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: vpc_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - vpc + /vpcs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: vpc_GetDetailsClassMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - vpc + post: + description: 执行操作ClassMetadata + operationId: vpc_PerformClassMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - vpc + /vpcs/{id}/disable: + post: + description: 执行操作Disable + operationId: vpc_PerformDisable + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformDisableOutput' + summary: 禁用资源 + tags: + - vpc + /vpcs/{id}/enable: + post: + description: 执行操作Enable + operationId: vpc_PerformEnable + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformEnableOutput' + summary: 启用资源 + tags: + - vpc + /vpcs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: vpc_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - vpc + /vpcs/{id}/private: + post: + description: 执行操作Private + operationId: vpc_PerformPrivate + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformPrivateOutput' + summary: 执行操作Private + tags: + - vpc + /vpcs/{id}/public: + post: + description: 执行操作Public + operationId: vpc_PerformPublic + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformPublicOutput' + summary: 执行操作Public + tags: + - vpc + /vpcs/{id}/purge: + post: + description: 执行操作Purge + operationId: vpc_PerformPurge + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_PerformPurgeOutput' + summary: 执行操作Purge + tags: + - vpc + /vpcs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: vpc_PerformSetClassMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - vpc + /vpcs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: vpc_PerformSetUserMetadata + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - vpc + /vpcs/{id}/status: + get: + description: 获取指定信息Status + operationId: vpc_GetDetailsStatus + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - vpc + post: + description: 执行操作Status + operationId: vpc_PerformStatus + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformStatusOutput' + summary: 更新资源状态 + tags: + - vpc + /vpcs/{id}/sync: + post: + description: 执行操作Sync + operationId: vpc_PerformSync + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/VpcSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSyncOutput' + summary: 执行操作Sync + tags: + - vpc + /vpcs/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: vpc_PerformSyncstatus + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/VpcSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformSyncstatusOutput' + summary: 同步VPC状态 + tags: + - vpc + /vpcs/{id}/topology: + get: + description: 获取指定信息Topology + operationId: vpc_GetDetailsTopology + parameters: + - description: The Id or Name of vpc + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/vpc_GetDetailsTopologyOutput' + summary: 获取指定信息Topology + tags: + - vpc + /vpcs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: vpc_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/vpc_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - vpc + /vpcs/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: vpc_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/vpc_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - vpc + /vpcs/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: vpc_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/vpc_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - vpc + /vpcs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: vpc_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + vpc: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/vpc_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - vpc + /vpcs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: vpc_GetPropertySplitable + responses: + "200": + $ref: '#/responses/vpc_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - vpc + /vpcs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: vpc_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/vpc_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - vpc + /vpcs/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: vpc_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/vpc_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - vpc + /vpcs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: vpc_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/vpc_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - vpc + /vpcs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: vpc_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/vpc_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - vpc + /waf_instances: + get: + description: 列表 + operationId: waf_instance_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/waf_instance_ListItemFilterOutput' + summary: 列出WAF实例 + tags: + - waf_instance + post: + description: 新建 + operationId: waf_instance_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_instance: + $ref: '#/definitions/WafInstanceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_instance + /waf_instances/{id}: + delete: + description: 删除 + operationId: waf_instance_CustomizeDelete + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_instance + get: + description: 获取详情 + operationId: waf_instance_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_instance + put: + description: 更新 + operationId: waf_instance_ValidateUpdateData + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/EnabledStatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_instance + /waf_instances/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: waf_instance_PerformChangeOwner + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - waf_instance + /waf_instances/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: waf_instance_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - waf_instance + /waf_instances/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_instance_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_instance + post: + description: 执行操作ClassMetadata + operationId: waf_instance_PerformClassMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_instance + /waf_instances/{id}/cloud-resources: + get: + description: 获取指定信息CloudResources + operationId: waf_instance_GetDetailsCloudResources + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsCloudResourcesOutput' + summary: 获取WAF绑定的资源列表 + tags: + - waf_instance + /waf_instances/{id}/disable: + post: + description: 执行操作Disable + operationId: waf_instance_PerformDisable + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformDisableOutput' + summary: 禁用资源 + tags: + - waf_instance + /waf_instances/{id}/enable: + post: + description: 执行操作Enable + operationId: waf_instance_PerformEnable + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformEnableOutput' + summary: 启用资源 + tags: + - waf_instance + /waf_instances/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_instance_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_instance + /waf_instances/{id}/private: + post: + description: 执行操作Private + operationId: waf_instance_PerformPrivate + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformPrivateOutput' + summary: 执行操作Private + tags: + - waf_instance + /waf_instances/{id}/public: + post: + description: 执行操作Public + operationId: waf_instance_PerformPublic + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformPublicOutput' + summary: 执行操作Public + tags: + - waf_instance + /waf_instances/{id}/remote-update: + post: + description: 执行操作RemoteUpdate + operationId: waf_instance_PerformRemoteUpdate + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/MongoDBRemoteUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformRemoteUpdateOutput' + summary: 执行操作RemoteUpdate + tags: + - waf_instance + /waf_instances/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_instance_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_instance + /waf_instances/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_instance_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_instance + /waf_instances/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_instance_GetDetailsStatus + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_instance_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_instance + post: + description: 执行操作Status + operationId: waf_instance_PerformStatus + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_instance + /waf_instances/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: waf_instance_PerformSyncstatus + parameters: + - description: The Id or Name of waf_instance + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/WafSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformSyncstatusOutput' + summary: 同步WAF状态 + tags: + - waf_instance + /waf_instances/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_instance_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_instance + /waf_instances/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: waf_instance_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - waf_instance + /waf_instances/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: waf_instance_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - waf_instance + /waf_instances/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_instance_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_instance: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_instance_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_instance + /waf_instances/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_instance_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_instance + /waf_instances/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_instance_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_instance + /waf_instances/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_instance_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_instance + /waf_instances/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_instance_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_instance + /waf_instances/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_instance_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_instance_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_instance + /waf_ip_set_caches: + get: + description: 列表 + operationId: waf_ip_set_cache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_ListItemFilterOutput' + summary: 列出WAF IPSet缓存 + tags: + - waf_ip_set_cache + post: + description: 新建 + operationId: waf_ip_set_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_ip_set_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}: + delete: + description: 删除 + operationId: waf_ip_set_cache_CustomizeDelete + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_ip_set_cache + get: + description: 获取详情 + operationId: waf_ip_set_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_ip_set_cache + put: + description: 更新 + operationId: waf_ip_set_cache_ValidateUpdateData + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_ip_set_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_ip_set_cache + post: + description: 执行操作ClassMetadata + operationId: waf_ip_set_cache_PerformClassMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_ip_set_cache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_ip_set_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_ip_set_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_ip_set_cache_GetDetailsStatus + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_ip_set_cache + post: + description: 执行操作Status + operationId: waf_ip_set_cache_PerformStatus + parameters: + - description: The Id or Name of waf_ip_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_ip_set_cache + /waf_ip_set_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_ip_set_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_ip_set_cache + /waf_ip_set_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_ip_set_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_ip_set_cache + /waf_ip_set_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_ip_set_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_ip_set_cache + /waf_ip_set_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_ip_set_cache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_ip_set_cache + /waf_ip_set_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_ip_set_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_ip_set_cache + /waf_ip_set_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_ip_set_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_ip_set_cache + /waf_ip_set_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_ip_set_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_ip_set_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_ip_set_cache + /waf_ip_sets: + get: + description: 列表 + operationId: waf_ip_set_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/waf_ip_set_ListItemFilterOutput' + summary: 列出WAF IPSets + tags: + - waf_ip_set + post: + description: 新建 + operationId: waf_ip_set_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_ip_set: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_ip_set + /waf_ip_sets/{id}: + delete: + description: 删除 + operationId: waf_ip_set_CustomizeDelete + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_ip_set + get: + description: 获取详情 + operationId: waf_ip_set_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_ip_set + put: + description: 更新 + operationId: waf_ip_set_ValidateUpdateData + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_ip_set + /waf_ip_sets/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: waf_ip_set_PerformChangeOwner + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - waf_ip_set + /waf_ip_sets/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: waf_ip_set_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - waf_ip_set + /waf_ip_sets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_ip_set_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_ip_set + post: + description: 执行操作ClassMetadata + operationId: waf_ip_set_PerformClassMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_ip_set + /waf_ip_sets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_ip_set_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_ip_set + /waf_ip_sets/{id}/private: + post: + description: 执行操作Private + operationId: waf_ip_set_PerformPrivate + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformPrivateOutput' + summary: 执行操作Private + tags: + - waf_ip_set + /waf_ip_sets/{id}/public: + post: + description: 执行操作Public + operationId: waf_ip_set_PerformPublic + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformPublicOutput' + summary: 执行操作Public + tags: + - waf_ip_set + /waf_ip_sets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_ip_set_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_ip_set + /waf_ip_sets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_ip_set_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_ip_set + /waf_ip_sets/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_ip_set_GetDetailsStatus + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_ip_set_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_ip_set + post: + description: 执行操作Status + operationId: waf_ip_set_PerformStatus + parameters: + - description: The Id or Name of waf_ip_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_ip_set + /waf_ip_sets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_ip_set_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_ip_set + /waf_ip_sets/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: waf_ip_set_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - waf_ip_set + /waf_ip_sets/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: waf_ip_set_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - waf_ip_set + /waf_ip_sets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_ip_set_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_ip_set: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_ip_set_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_ip_set + /waf_ip_sets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_ip_set_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_ip_set + /waf_ip_sets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_ip_set_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_ip_set + /waf_ip_sets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_ip_set_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_ip_set + /waf_ip_sets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_ip_set_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_ip_set + /waf_ip_sets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_ip_set_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_ip_set_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_ip_set + /waf_regex_set_caches: + get: + description: 列表 + operationId: waf_regex_set_cache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_ListItemFilterOutput' + summary: 列出WAF RegexSet缓存 + tags: + - waf_regex_set_cache + post: + description: 新建 + operationId: waf_regex_set_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_regex_set_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}: + delete: + description: 删除 + operationId: waf_regex_set_cache_CustomizeDelete + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_regex_set_cache + get: + description: 获取详情 + operationId: waf_regex_set_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_regex_set_cache + put: + description: 更新 + operationId: waf_regex_set_cache_ValidateUpdateData + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_regex_set_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_regex_set_cache + post: + description: 执行操作ClassMetadata + operationId: waf_regex_set_cache_PerformClassMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_regex_set_cache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_regex_set_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_regex_set_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_regex_set_cache_GetDetailsStatus + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_regex_set_cache + post: + description: 执行操作Status + operationId: waf_regex_set_cache_PerformStatus + parameters: + - description: The Id or Name of waf_regex_set_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_regex_set_cache + /waf_regex_set_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_regex_set_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_regex_set_cache + /waf_regex_set_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_regex_set_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_regex_set_cache + /waf_regex_set_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_regex_set_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_regex_set_cache + /waf_regex_set_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_regex_set_cache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_regex_set_cache + /waf_regex_set_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_regex_set_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_regex_set_cache + /waf_regex_set_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_regex_set_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_regex_set_cache + /waf_regex_set_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_regex_set_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_regex_set_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_regex_set_cache + /waf_regex_sets: + get: + description: 列表 + operationId: waf_regex_set_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/waf_regex_set_ListItemFilterOutput' + summary: 列出WAF RegexSets + tags: + - waf_regex_set + post: + description: 新建 + operationId: waf_regex_set_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_regex_set: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_regex_set + /waf_regex_sets/{id}: + delete: + description: 删除 + operationId: waf_regex_set_CustomizeDelete + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_regex_set + get: + description: 获取详情 + operationId: waf_regex_set_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_regex_set + put: + description: 更新 + operationId: waf_regex_set_ValidateUpdateData + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_regex_set + /waf_regex_sets/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: waf_regex_set_PerformChangeOwner + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - waf_regex_set + /waf_regex_sets/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: waf_regex_set_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - waf_regex_set + /waf_regex_sets/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_regex_set_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_regex_set + post: + description: 执行操作ClassMetadata + operationId: waf_regex_set_PerformClassMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_regex_set + /waf_regex_sets/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_regex_set_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_regex_set + /waf_regex_sets/{id}/private: + post: + description: 执行操作Private + operationId: waf_regex_set_PerformPrivate + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformPrivateOutput' + summary: 执行操作Private + tags: + - waf_regex_set + /waf_regex_sets/{id}/public: + post: + description: 执行操作Public + operationId: waf_regex_set_PerformPublic + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformPublicOutput' + summary: 执行操作Public + tags: + - waf_regex_set + /waf_regex_sets/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_regex_set_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_regex_set + /waf_regex_sets/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_regex_set_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_regex_set + /waf_regex_sets/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_regex_set_GetDetailsStatus + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_regex_set_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_regex_set + post: + description: 执行操作Status + operationId: waf_regex_set_PerformStatus + parameters: + - description: The Id or Name of waf_regex_set + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_regex_set + /waf_regex_sets/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_regex_set_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_regex_set + /waf_regex_sets/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: waf_regex_set_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - waf_regex_set + /waf_regex_sets/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: waf_regex_set_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - waf_regex_set + /waf_regex_sets/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_regex_set_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_regex_set: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_regex_set_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_regex_set + /waf_regex_sets/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_regex_set_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_regex_set + /waf_regex_sets/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_regex_set_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_regex_set + /waf_regex_sets/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_regex_set_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_regex_set + /waf_regex_sets/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_regex_set_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_regex_set + /waf_regex_sets/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_regex_set_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_regex_set_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_regex_set + /waf_rule_group_caches: + get: + description: 列表 + operationId: waf_rule_group_cache_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_ListItemFilterOutput' + summary: 列出WAF RuleGroup缓存 + tags: + - waf_rule_group_cache + post: + description: 新建 + operationId: waf_rule_group_cache_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_rule_group_cache: + $ref: '#/definitions/StatusStandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}: + delete: + description: 删除 + operationId: waf_rule_group_cache_CustomizeDelete + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_rule_group_cache + get: + description: 获取详情 + operationId: waf_rule_group_cache_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_rule_group_cache + put: + description: 更新 + operationId: waf_rule_group_cache_ValidateUpdateData + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_rule_group_cache_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_rule_group_cache + post: + description: 执行操作ClassMetadata + operationId: waf_rule_group_cache_PerformClassMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_rule_group_cache_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_rule_group_cache_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_rule_group_cache_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_rule_group_cache_GetDetailsStatus + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_rule_group_cache + post: + description: 执行操作Status + operationId: waf_rule_group_cache_PerformStatus + parameters: + - description: The Id or Name of waf_rule_group_cache + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_rule_group_cache + /waf_rule_group_caches/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_rule_group_cache_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_rule_group_cache + /waf_rule_group_caches/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_rule_group_cache_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_rule_group_cache + /waf_rule_group_caches/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_rule_group_cache_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_rule_group_cache + /waf_rule_group_caches/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_rule_group_cache_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_rule_group_cache + /waf_rule_group_caches/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_rule_group_cache_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_rule_group_cache + /waf_rule_group_caches/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_rule_group_cache_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_rule_group_cache + /waf_rule_group_caches/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_rule_group_cache_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_rule_group_cache_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_rule_group_cache + /waf_rule_groups: + get: + description: 列表 + operationId: waf_rule_group_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 是否是系统RuleGroup + in: query + name: is_system + type: boolean + x-go-name: IsSystem + - description: 云平台 + in: query + name: provider + type: string + x-go-name: Provider + - description: 云环境 + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + responses: + "200": + $ref: '#/responses/waf_rule_group_ListItemFilterOutput' + summary: 列出WAF RuleGroups + tags: + - waf_rule_group + post: + description: 新建 + operationId: waf_rule_group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_rule_group: + $ref: '#/definitions/StatusInfrasResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_rule_group + /waf_rule_groups/{id}: + delete: + description: 删除 + operationId: waf_rule_group_CustomizeDelete + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_rule_group + get: + description: 获取详情 + operationId: waf_rule_group_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_rule_group + put: + description: 更新 + operationId: waf_rule_group_ValidateUpdateData + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/StatusInfrasResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_rule_group + /waf_rule_groups/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: waf_rule_group_PerformChangeOwner + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - waf_rule_group + /waf_rule_groups/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: waf_rule_group_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - waf_rule_group + /waf_rule_groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_rule_group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_rule_group + post: + description: 执行操作ClassMetadata + operationId: waf_rule_group_PerformClassMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_rule_group + /waf_rule_groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_rule_group_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_rule_group + /waf_rule_groups/{id}/private: + post: + description: 执行操作Private + operationId: waf_rule_group_PerformPrivate + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformPrivateOutput' + summary: 执行操作Private + tags: + - waf_rule_group + /waf_rule_groups/{id}/public: + post: + description: 执行操作Public + operationId: waf_rule_group_PerformPublic + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformPublicOutput' + summary: 执行操作Public + tags: + - waf_rule_group + /waf_rule_groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_rule_group_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule_group + /waf_rule_groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_rule_group_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_rule_group + /waf_rule_groups/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_rule_group_GetDetailsStatus + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_group_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_rule_group + post: + description: 执行操作Status + operationId: waf_rule_group_PerformStatus + parameters: + - description: The Id or Name of waf_rule_group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_rule_group + /waf_rule_groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_rule_group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_rule_group + /waf_rule_groups/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: waf_rule_group_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - waf_rule_group + /waf_rule_groups/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: waf_rule_group_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - waf_rule_group + /waf_rule_groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_rule_group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_rule_group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_rule_group + /waf_rule_groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_rule_group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_rule_group + /waf_rule_groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_rule_group_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_rule_group + /waf_rule_groups/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_rule_group_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_rule_group + /waf_rule_groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_rule_group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_rule_group + /waf_rule_groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_rule_group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_rule_group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_rule_group + /waf_rule_statements: + get: + description: 列表 + operationId: waf_rule_statement_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/waf_rule_statement_ListItemFilterOutput' + summary: 列表 + tags: + - waf_rule_statement + post: + description: 新建 + operationId: waf_rule_statement_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_rule_statement: + $ref: '#/definitions/ResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_statement_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_rule_statement + /waf_rule_statements/{id}: + delete: + description: 删除 + operationId: waf_rule_statement_CustomizeDelete + parameters: + - description: The Id or Name of waf_rule_statement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_statement_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_rule_statement + get: + description: 获取详情 + operationId: waf_rule_statement_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_rule_statement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_statement_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_rule_statement + put: + description: 更新 + operationId: waf_rule_statement_ValidateUpdateData + parameters: + - description: The Id or Name of waf_rule_statement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_statement_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_rule_statement + /waf_rule_statements/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_rule_statement_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_rule_statement_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_rule_statement + /waf_rule_statements/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_rule_statement_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_statement_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_rule_statement + /waf_rule_statements/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_rule_statement_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_rule_statement_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_rule_statement + /waf_rule_statements/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_rule_statement_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_rule_statement_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_rule_statement + /waf_rules: + get: + description: 列表 + operationId: waf_rule_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: WAF实例Id + in: query + name: waf_instance_id + type: string + x-go-name: WafInstanceId + - description: WAF规则组Id + in: query + name: waf_rule_group_id + type: string + x-go-name: WafRuleGroupId + responses: + "200": + $ref: '#/responses/waf_rule_ListItemFilterOutput' + summary: 列出WAF规则 + tags: + - waf_rule + post: + description: 新建 + operationId: waf_rule_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + waf_rule: + $ref: '#/definitions/WafRuleCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_ValidateCreateDataOutput' + summary: 新建 + tags: + - waf_rule + /waf_rules/{id}: + delete: + description: 删除 + operationId: waf_rule_CustomizeDelete + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_CustomizeDeleteOutput' + summary: 删除 + tags: + - waf_rule + get: + description: 获取详情 + operationId: waf_rule_FetchCustomizeColumns + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - waf_rule + put: + description: 更新 + operationId: waf_rule_ValidateUpdateData + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_ValidateUpdateDataOutput' + summary: 更新 + tags: + - waf_rule + /waf_rules/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: waf_rule_GetDetailsClassMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - waf_rule + post: + description: 执行操作ClassMetadata + operationId: waf_rule_PerformClassMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - waf_rule + /waf_rules/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: waf_rule_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - waf_rule + /waf_rules/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: waf_rule_PerformSetClassMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - waf_rule + /waf_rules/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: waf_rule_PerformSetUserMetadata + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - waf_rule + /waf_rules/{id}/status: + get: + description: 获取指定信息Status + operationId: waf_rule_GetDetailsStatus + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/waf_rule_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - waf_rule + post: + description: 执行操作Status + operationId: waf_rule_PerformStatus + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformStatusOutput' + summary: 更新资源状态 + tags: + - waf_rule + /waf_rules/{id}/syncstatus: + post: + description: 执行操作Syncstatus + operationId: waf_rule_PerformSyncstatus + parameters: + - description: The Id or Name of waf_rule + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + waf_rule: + $ref: '#/definitions/WafSyncstatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformSyncstatusOutput' + summary: 同步WAF规则状态 + tags: + - waf_rule + /waf_rules/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: waf_rule_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - waf_rule + /waf_rules/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: waf_rule_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + waf_rule: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/waf_rule_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - waf_rule + /waf_rules/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: waf_rule_GetPropertySplitable + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - waf_rule + /waf_rules/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: waf_rule_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - waf_rule + /waf_rules/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: waf_rule_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - waf_rule + /waf_rules/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: waf_rule_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - waf_rule + /waf_rules/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: waf_rule_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/waf_rule_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - waf_rule + /wires: + get: + description: 列表 + operationId: wire_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 关联VPC(ID或Name) + in: query + name: vpc_id + type: string + x-go-name: VpcId + - description: Vpc外网访问模式 + in: query + name: external_access_mode + type: string + x-go-name: ExternalAccessMode + - description: 按VPC名称排序 + in: query + name: order_by_vpc + pattern: asc|desc + type: string + x-go-name: OrderByVpc + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 可用区ID或名称 + example: zone1 + in: query + name: zone_id + type: string + x-go-name: ZoneId + - description: 过滤处于多个指定可用区内的资源 + in: query + items: + type: string + name: zone_ids + type: array + x-go-name: ZoneIds + - description: 按可用区名称排序 + in: query + name: order_by_zone + pattern: asc|desc + type: string + x-go-name: OrderByZone + - description: 宿主机或物理机（ID或Name） + in: query + name: host_id + type: string + x-go-name: HostId + - format: int64 + in: query + name: bandwidth + type: integer + x-go-name: Bandwidth + - in: query + name: host_type + type: string + x-go-name: HostType + - description: 按子网数量排序 + in: query + name: order_by_network_count + pattern: asc|desc + type: string + x-go-name: OrderByNetworkCount + responses: + "200": + $ref: '#/responses/wire_ListItemFilterOutput' + summary: 二层网络列表 + tags: + - wire + post: + description: 新建 + operationId: wire_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + wire: + $ref: '#/definitions/WireCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_ValidateCreateDataOutput' + summary: 新建 + tags: + - wire + /wires/{id}: + delete: + description: 删除 + operationId: wire_CustomizeDelete + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_CustomizeDeleteOutput' + summary: 删除 + tags: + - wire + get: + description: 获取详情 + operationId: wire_FetchCustomizeColumns + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - wire + put: + description: 更新 + operationId: wire_ValidateUpdateData + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/WireUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_ValidateUpdateDataOutput' + summary: 更新 + tags: + - wire + /wires/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: wire_PerformChangeOwner + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - wire + /wires/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: wire_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - wire + /wires/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: wire_GetDetailsClassMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - wire + post: + description: 执行操作ClassMetadata + operationId: wire_PerformClassMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - wire + /wires/{id}/merge-from: + post: + description: 执行操作MergeFrom + operationId: wire_PerformMergeFrom + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/WireMergeFromInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformMergeFromOutput' + summary: 执行操作MergeFrom + tags: + - wire + /wires/{id}/merge-network: + post: + description: 执行操作MergeNetwork + operationId: wire_PerformMergeNetwork + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/WireMergeNetworkInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformMergeNetworkOutput' + summary: 执行操作MergeNetwork + tags: + - wire + /wires/{id}/merge-to: + post: + description: 执行操作MergeTo + operationId: wire_PerformMergeTo + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/WireMergeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformMergeToOutput' + summary: 执行操作MergeTo + tags: + - wire + /wires/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: wire_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - wire + /wires/{id}/private: + post: + description: 执行操作Private + operationId: wire_PerformPrivate + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformPrivateOutput' + summary: 执行操作Private + tags: + - wire + /wires/{id}/public: + post: + description: 执行操作Public + operationId: wire_PerformPublic + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformPublicOutput' + summary: 执行操作Public + tags: + - wire + /wires/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: wire_PerformSetClassMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformSetClassMetadataOutput' + summary: 执行操作SetClassMetadata + tags: + - wire + /wires/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: wire_PerformSetUserMetadata + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - wire + /wires/{id}/status: + get: + description: 获取指定信息Status + operationId: wire_GetDetailsStatus + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - wire + post: + description: 执行操作Status + operationId: wire_PerformStatus + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformStatusOutput' + summary: 更新资源状态 + tags: + - wire + /wires/{id}/topology: + get: + description: 获取指定信息Topology + operationId: wire_GetDetailsTopology + parameters: + - description: The Id or Name of wire + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/wire_GetDetailsTopologyOutput' + summary: 获取指定信息Topology + tags: + - wire + /wires/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: wire_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/wire_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - wire + /wires/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: wire_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/wire_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - wire + /wires/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: wire_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/wire_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - wire + /wires/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: wire_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + wire: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/wire_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - wire + /wires/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: wire_GetPropertySplitable + responses: + "200": + $ref: '#/responses/wire_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - wire + /wires/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: wire_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/wire_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - wire + /wires/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: wire_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/wire_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - wire + /wires/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: wire_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/wire_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - wire + /wires/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: wire_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/wire_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - wire + /zone_quotas/{scope}: + get: + description: 获取所有项目或者域的可用区配额 + operationId: models_ListZoneQuotas + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListZoneQuotasOutput' + summary: 获取所有项目或者域的可用区配额 + tags: + - zone_quota + /zone_quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的可用区配额 + operationId: models_GetZoneQuota + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + responses: + "200": + $ref: '#/responses/models_GetZoneQuotaOutput' + summary: 获取指定项目或者域的可用区配额 + tags: + - zone_quota + post: + description: 设置指定项目或者域的可用区配额 + operationId: models_SetZoneQuotas + parameters: + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - in: body + name: body + schema: + properties: + zone_quotas: + $ref: '#/definitions/SetZoneQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetZoneQuotasOutput' + summary: 设置指定项目或者域的可用区配额 + tags: + - zone_quota + /zones: + get: + description: 列表 + operationId: zone_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源外部ID过滤 + in: query + name: external_id + type: string + x-go-name: ExternalId + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - description: 区域名称或ID + in: query + name: cloudregion_id + type: string + x-go-name: CloudregionId + - description: 过滤位于指定城市区域的资源 + in: query + name: city + type: string + x-go-name: City + - description: 按区域名称过滤 + in: query + name: order_by_region + type: string + x-go-name: OrderByRegion + - description: 按城市过滤 + in: query + name: order_by_city + type: string + x-go-name: OrderByCity + - description: filter by network usability of the resource + in: query + name: usable + type: boolean + x-go-name: Usable + - description: filter by Vpc usability of the resource + in: query + name: usable_vpc + type: boolean + x-go-name: UsableVpc + - description: 过滤提供特定服务的可用区 + in: query + name: service + type: string + x-go-name: Service + - in: query + items: + type: string + name: location + type: array + x-go-name: Location + - in: query + items: + type: string + name: contacts + type: array + x-go-name: Contacts + - in: query + name: OrderByWires + type: string + - in: query + name: OrderByHosts + type: string + - in: query + name: OrderByHostsEnabled + type: string + - in: query + name: OrderByBaremetals + type: string + - in: query + name: OrderByBaremetalsEnabled + type: string + responses: + "200": + $ref: '#/responses/zone_ListItemFilterOutput' + summary: 可用区列表 + tags: + - zone + post: + description: 新建 + operationId: zone_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + zone: + $ref: '#/definitions/ZoneCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_ValidateCreateDataOutput' + summary: 新建 + tags: + - zone + /zones/{id}: + delete: + description: 删除 + operationId: zone_CustomizeDelete + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_CustomizeDeleteOutput' + summary: 删除 + tags: + - zone + get: + description: 获取详情 + operationId: zone_FetchCustomizeColumns + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - zone + put: + description: 更新 + operationId: zone_ValidateUpdateData + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_ValidateUpdateDataOutput' + summary: 更新 + tags: + - zone + /zones/{id}/capability: + get: + description: 获取指定信息Capability + operationId: zone_GetDetailsCapability + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsCapabilityOutput' + summary: 获取指定信息Capability + tags: + - zone + /zones/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: zone_GetDetailsClassMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - zone + post: + description: 执行操作ClassMetadata + operationId: zone_PerformClassMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - zone + /zones/{id}/disk-capability: + get: + description: 获取指定信息DiskCapability + operationId: zone_GetDetailsDiskCapability + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsDiskCapabilityOutput' + summary: 获取指定信息DiskCapability + tags: + - zone + /zones/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: zone_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - zone + /zones/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: zone_PerformSetClassMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - zone + /zones/{id}/set-schedtag: + post: + description: 执行操作SetSchedtag + operationId: zone_PerformSetSchedtag + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_PerformSetSchedtagOutput' + summary: 执行操作SetSchedtag + tags: + - zone + /zones/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: zone_PerformSetUserMetadata + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - zone + /zones/{id}/status: + get: + description: 获取指定信息Status + operationId: zone_GetDetailsStatus + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/zone_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - zone + post: + description: 执行操作Status + operationId: zone_PerformStatus + parameters: + - description: The Id or Name of zone + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + zone: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformStatusOutput' + summary: 更新资源状态 + tags: + - zone + /zones/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: zone_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/zone_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - zone + /zones/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: zone_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + zone: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/zone_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - zone + /zones/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: zone_GetPropertySplitable + responses: + "200": + $ref: '#/responses/zone_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - zone + /zones/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: zone_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/zone_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - zone + /zones/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: zone_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/zone_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - zone + /zones/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: zone_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/zone_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - zone + /zones/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: zone_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/zone_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - zone +produces: +- application/json +responses: + access_group_CustomizeDeleteOutput: + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupDetails' + type: object + access_group_FetchCustomizeColumnsOutput: + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupDetails' + type: object + access_group_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + access_group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + access_group_GetDetailsClassMetadataOutput: + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_GetDetailsMetadataOutput: + schema: + properties: + access_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_GetDetailsStatusOutput: + schema: + properties: + access_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + access_group_GetPropertyDistinctFieldOutput: {} + access_group_GetPropertyDomainTagValuePairsOutput: {} + access_group_GetPropertyDomainTagValueTreeOutput: {} + access_group_GetPropertySplitableExportOutput: {} + access_group_GetPropertySplitableOutput: {} + access_group_GetPropertyStatisticsOutput: + schema: + properties: + access_group: + $ref: '#/definitions/StatusStatistic' + type: object + access_group_GetPropertyTagValuePairsOutput: {} + access_group_GetPropertyTagValueTreeOutput: {} + access_group_ListItemFilterOutput: + schema: + properties: + access_groups: + items: + $ref: '#/definitions/AccessGroupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + access_group_PerformChangeOwnerOutput: {} + access_group_PerformClassMetadataOutput: {} + access_group_PerformPrivateOutput: {} + access_group_PerformPublicOutput: {} + access_group_PerformPurgeSplitableOutput: {} + access_group_PerformSetClassMetadataOutput: {} + access_group_PerformSetUserMetadataOutput: {} + access_group_PerformStatusOutput: {} + access_group_PerformSyncstatusOutput: {} + access_group_ValidateCreateDataOutput: + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupDetails' + type: object + access_group_ValidateUpdateDataOutput: + schema: + properties: + access_group: + $ref: '#/definitions/AccessGroupDetails' + type: object + access_group_cache_CustomizeDeleteOutput: + schema: + properties: + access_group_cache: + $ref: '#/definitions/AccessGroupCacheDetails' + type: object + access_group_cache_FetchCustomizeColumnsOutput: + schema: + properties: + access_group_cache: + $ref: '#/definitions/AccessGroupCacheDetails' + type: object + access_group_cache_GetDetailsClassMetadataOutput: + schema: + properties: + access_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_cache_GetDetailsMetadataOutput: + schema: + properties: + access_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + access_group_cache_GetDetailsStatusOutput: + schema: + properties: + access_group_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + access_group_cache_GetPropertyDistinctFieldOutput: {} + access_group_cache_GetPropertySplitableExportOutput: {} + access_group_cache_GetPropertySplitableOutput: {} + access_group_cache_GetPropertyStatisticsOutput: + schema: + properties: + access_group_cache: + $ref: '#/definitions/StatusStatistic' + type: object + access_group_cache_GetPropertyTagValuePairsOutput: {} + access_group_cache_GetPropertyTagValueTreeOutput: {} + access_group_cache_ListItemFilterOutput: + schema: + properties: + access_group_caches: + items: + $ref: '#/definitions/AccessGroupCacheDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + access_group_cache_PerformClassMetadataOutput: {} + access_group_cache_PerformPurgeSplitableOutput: {} + access_group_cache_PerformSetClassMetadataOutput: {} + access_group_cache_PerformSetUserMetadataOutput: {} + access_group_cache_PerformStatusOutput: {} + access_group_cache_PerformSyncstatusOutput: {} + access_group_cache_ValidateCreateDataOutput: + schema: + properties: + access_group_cache: + $ref: '#/definitions/AccessGroupCacheDetails' + type: object + access_group_cache_ValidateUpdateDataOutput: + schema: + properties: + access_group_cache: + $ref: '#/definitions/AccessGroupCacheDetails' + type: object + access_group_rule_CustomizeDeleteOutput: + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleDetails' + type: object + access_group_rule_FetchCustomizeColumnsOutput: + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleDetails' + type: object + access_group_rule_GetPropertyDistinctFieldOutput: {} + access_group_rule_GetPropertySplitableExportOutput: {} + access_group_rule_GetPropertySplitableOutput: {} + access_group_rule_ListItemFilterOutput: + schema: + properties: + access_group_rules: + items: + $ref: '#/definitions/AccessGroupRuleDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + access_group_rule_PerformPurgeSplitableOutput: {} + access_group_rule_ValidateCreateDataOutput: + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleDetails' + type: object + access_group_rule_ValidateUpdateDataOutput: + schema: + properties: + access_group_rule: + $ref: '#/definitions/AccessGroupRuleDetails' + type: object + app_CustomizeDeleteOutput: + schema: + properties: + app: + $ref: '#/definitions/AppDetails' + type: object + app_FetchCustomizeColumnsOutput: + schema: + properties: + app: + $ref: '#/definitions/AppDetails' + type: object + app_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + app: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + app_GetDetailsClassMetadataOutput: + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_GetDetailsMetadataOutput: + schema: + properties: + app: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_GetDetailsStatusOutput: + schema: + properties: + app: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + app_GetPropertyDistinctFieldOutput: {} + app_GetPropertyDomainStatisticsOutput: + schema: + properties: + app: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + app_GetPropertyProjectStatisticsOutput: + schema: + properties: + app: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + app_GetPropertyProjectTagValuePairsOutput: {} + app_GetPropertyProjectTagValueTreeOutput: {} + app_GetPropertySplitableExportOutput: {} + app_GetPropertySplitableOutput: {} + app_GetPropertyStatisticsOutput: + schema: + properties: + app: + $ref: '#/definitions/StatusStatistic' + type: object + app_GetPropertyTagValuePairsOutput: {} + app_GetPropertyTagValueTreeOutput: {} + app_ListItemFilterOutput: + schema: + properties: + apps: + items: + $ref: '#/definitions/AppDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + app_PerformCancelDeleteOutput: {} + app_PerformChangeOwnerOutput: {} + app_PerformClassMetadataOutput: {} + app_PerformFreezeOutput: {} + app_PerformPurgeSplitableOutput: {} + app_PerformRemoteUpdateOutput: {} + app_PerformSetClassMetadataOutput: {} + app_PerformSetUserMetadataOutput: {} + app_PerformStatusOutput: {} + app_PerformSyncstatusOutput: {} + app_PerformUnfreezeOutput: {} + app_ValidateCreateDataOutput: + schema: + properties: + app: + $ref: '#/definitions/AppDetails' + type: object + app_ValidateUpdateDataOutput: + schema: + properties: + app: + $ref: '#/definitions/AppDetails' + type: object + app_environment_CustomizeDeleteOutput: + schema: + properties: + app_environment: + $ref: '#/definitions/AppEnvironmentDetails' + type: object + app_environment_FetchCustomizeColumnsOutput: + schema: + properties: + app_environment: + $ref: '#/definitions/AppEnvironmentDetails' + type: object + app_environment_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + app_environment: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + app_environment_GetDetailsClassMetadataOutput: + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_environment_GetDetailsMetadataOutput: + schema: + properties: + app_environment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + app_environment_GetDetailsStatusOutput: + schema: + properties: + app_environment: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + app_environment_GetPropertyDistinctFieldOutput: {} + app_environment_GetPropertyDomainStatisticsOutput: + schema: + properties: + app_environment: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + app_environment_GetPropertyProjectStatisticsOutput: + schema: + properties: + app_environment: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + app_environment_GetPropertyProjectTagValuePairsOutput: {} + app_environment_GetPropertyProjectTagValueTreeOutput: {} + app_environment_GetPropertySplitableExportOutput: {} + app_environment_GetPropertySplitableOutput: {} + app_environment_GetPropertyStatisticsOutput: + schema: + properties: + app_environment: + $ref: '#/definitions/StatusStatistic' + type: object + app_environment_GetPropertyTagValuePairsOutput: {} + app_environment_GetPropertyTagValueTreeOutput: {} + app_environment_ListItemFilterOutput: + schema: + properties: + app_environments: + items: + $ref: '#/definitions/AppEnvironmentDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + app_environment_PerformCancelDeleteOutput: {} + app_environment_PerformChangeOwnerOutput: {} + app_environment_PerformClassMetadataOutput: {} + app_environment_PerformFreezeOutput: {} + app_environment_PerformPurgeSplitableOutput: {} + app_environment_PerformSetClassMetadataOutput: {} + app_environment_PerformSetUserMetadataOutput: {} + app_environment_PerformStatusOutput: {} + app_environment_PerformUnfreezeOutput: {} + app_environment_ValidateCreateDataOutput: + schema: + properties: + app_environment: + $ref: '#/definitions/AppEnvironmentDetails' + type: object + app_environment_ValidateUpdateDataOutput: + schema: + properties: + app_environment: + $ref: '#/definitions/AppEnvironmentDetails' + type: object + backup_storage_CustomizeDeleteOutput: + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageDetails' + type: object + backup_storage_FetchCustomizeColumnsOutput: + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageDetails' + type: object + backup_storage_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + backup_storage: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + backup_storage_GetDetailsClassMetadataOutput: + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + backup_storage_GetDetailsMetadataOutput: + schema: + properties: + backup_storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + backup_storage_GetDetailsStatusOutput: + schema: + properties: + backup_storage: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + backup_storage_GetPropertyDistinctFieldOutput: {} + backup_storage_GetPropertyDomainTagValuePairsOutput: {} + backup_storage_GetPropertyDomainTagValueTreeOutput: {} + backup_storage_GetPropertySplitableExportOutput: {} + backup_storage_GetPropertySplitableOutput: {} + backup_storage_GetPropertyStatisticsOutput: + schema: + properties: + backup_storage: + $ref: '#/definitions/StatusStatistic' + type: object + backup_storage_GetPropertyTagValuePairsOutput: {} + backup_storage_GetPropertyTagValueTreeOutput: {} + backup_storage_ListItemFilterOutput: + schema: + properties: + backup_storages: + items: + $ref: '#/definitions/BackupStorageDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + backup_storage_PerformChangeOwnerOutput: {} + backup_storage_PerformClassMetadataOutput: {} + backup_storage_PerformDisableOutput: {} + backup_storage_PerformEnableOutput: {} + backup_storage_PerformPrivateOutput: {} + backup_storage_PerformPublicOutput: {} + backup_storage_PerformPurgeSplitableOutput: {} + backup_storage_PerformSetClassMetadataOutput: {} + backup_storage_PerformSetUserMetadataOutput: {} + backup_storage_PerformStatusOutput: {} + backup_storage_PerformSyncstatusOutput: {} + backup_storage_ValidateCreateDataOutput: + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageDetails' + type: object + backup_storage_ValidateUpdateDataOutput: + schema: + properties: + backup_storage: + $ref: '#/definitions/BackupStorageDetails' + type: object + baremetalagent_CustomizeDeleteOutput: + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentDetails' + type: object + baremetalagent_FetchCustomizeColumnsOutput: + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentDetails' + type: object + baremetalagent_GetDetailsClassMetadataOutput: + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + baremetalagent_GetDetailsMetadataOutput: + schema: + properties: + baremetalagent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + baremetalagent_GetPropertyDistinctFieldOutput: {} + baremetalagent_GetPropertySplitableExportOutput: {} + baremetalagent_GetPropertySplitableOutput: {} + baremetalagent_GetPropertyTagValuePairsOutput: {} + baremetalagent_GetPropertyTagValueTreeOutput: {} + baremetalagent_ListItemFilterOutput: + schema: + properties: + baremetalagents: + items: + $ref: '#/definitions/BaremetalagentDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + baremetalagent_PerformClassMetadataOutput: {} + baremetalagent_PerformDisableImageCacheOutput: {} + baremetalagent_PerformDisableOutput: {} + baremetalagent_PerformEnableImageCacheOutput: {} + baremetalagent_PerformEnableOutput: {} + baremetalagent_PerformOfflineOutput: {} + baremetalagent_PerformOnlineOutput: {} + baremetalagent_PerformPurgeSplitableOutput: {} + baremetalagent_PerformSetClassMetadataOutput: {} + baremetalagent_PerformSetUserMetadataOutput: {} + baremetalagent_ValidateCreateDataOutput: + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentDetails' + type: object + baremetalagent_ValidateUpdateDataOutput: + schema: + properties: + baremetalagent: + $ref: '#/definitions/BaremetalagentDetails' + type: object + billing_resource_check_CustomizeDeleteOutput: + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseDetails' + type: object + billing_resource_check_FetchCustomizeColumnsOutput: + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseDetails' + type: object + billing_resource_check_GetPropertyDistinctFieldOutput: {} + billing_resource_check_GetPropertySplitableExportOutput: {} + billing_resource_check_GetPropertySplitableOutput: {} + billing_resource_check_ListItemFilterOutput: + schema: + properties: + billing_resource_checks: + items: + $ref: '#/definitions/ResourceBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + billing_resource_check_PerformPurgeSplitableOutput: {} + billing_resource_check_ValidateCreateDataOutput: + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseDetails' + type: object + billing_resource_check_ValidateUpdateDataOutput: + schema: + properties: + billing_resource_check: + $ref: '#/definitions/ResourceBaseDetails' + type: object + bucket_CustomizeDeleteOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketDetails' + type: object + bucket_FetchCustomizeColumnsOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketDetails' + type: object + bucket_GetDetailsAccessInfoOutput: {} + bucket_GetDetailsAclOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketGetAclOutput' + type: object + bucket_GetDetailsCdnDomainOutput: + schema: + properties: + bucket: + $ref: '#/definitions/CdnDomains' + type: object + bucket_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + bucket: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + bucket_GetDetailsClassMetadataOutput: + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + bucket_GetDetailsCorsOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketCORSRules' + type: object + bucket_GetDetailsMetadataOutput: + schema: + properties: + bucket: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + bucket_GetDetailsObjectsOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketGetObjectsOutput' + type: object + bucket_GetDetailsPolicyOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketPolicy' + type: object + bucket_GetDetailsRefererOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketRefererConf' + type: object + bucket_GetDetailsStatusOutput: + schema: + properties: + bucket: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + bucket_GetDetailsWebsiteOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketWebsiteConf' + type: object + bucket_GetPropertyDistinctFieldOutput: {} + bucket_GetPropertyDomainStatisticsOutput: + schema: + properties: + bucket: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + bucket_GetPropertyProjectStatisticsOutput: + schema: + properties: + bucket: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + bucket_GetPropertyProjectTagValuePairsOutput: {} + bucket_GetPropertyProjectTagValueTreeOutput: {} + bucket_GetPropertySplitableExportOutput: {} + bucket_GetPropertySplitableOutput: {} + bucket_GetPropertyStatisticsOutput: + schema: + properties: + bucket: + $ref: '#/definitions/StatusStatistic' + type: object + bucket_GetPropertyTagValuePairsOutput: {} + bucket_GetPropertyTagValueTreeOutput: {} + bucket_ListItemFilterOutput: + schema: + properties: + buckets: + items: + $ref: '#/definitions/BucketDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + bucket_PerformAclOutput: {} + bucket_PerformCancelDeleteOutput: {} + bucket_PerformChangeOwnerOutput: {} + bucket_PerformClassMetadataOutput: {} + bucket_PerformDeleteCorsOutput: {} + bucket_PerformDeleteOutput: {} + bucket_PerformDeletePolicyOutput: {} + bucket_PerformDeleteWebsiteOutput: {} + bucket_PerformFreezeOutput: {} + bucket_PerformLimitOutput: {} + bucket_PerformMakedirOutput: {} + bucket_PerformMetadataOutput: {} + bucket_PerformPrivateOutput: {} + bucket_PerformPublicOutput: {} + bucket_PerformPurgeSplitableOutput: {} + bucket_PerformSetClassMetadataOutput: {} + bucket_PerformSetCorsOutput: {} + bucket_PerformSetPolicyOutput: {} + bucket_PerformSetRefererOutput: {} + bucket_PerformSetUserMetadataOutput: {} + bucket_PerformSetWebsiteOutput: {} + bucket_PerformStatusOutput: {} + bucket_PerformSyncOutput: {} + bucket_PerformSyncstatusOutput: {} + bucket_PerformTempUrlOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketPerformTempUrlOutput' + type: object + bucket_PerformUnfreezeOutput: {} + bucket_PerformUploadOutput: {} + bucket_ValidateCreateDataOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketDetails' + type: object + bucket_ValidateUpdateDataOutput: + schema: + properties: + bucket: + $ref: '#/definitions/BucketDetails' + type: object + cachedimage_CustomizeDeleteOutput: + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedimageDetails' + type: object + cachedimage_FetchCustomizeColumnsOutput: + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedimageDetails' + type: object + cachedimage_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + cachedimage: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cachedimage_GetDetailsClassMetadataOutput: + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cachedimage_GetDetailsMetadataOutput: + schema: + properties: + cachedimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cachedimage_GetDetailsStatusOutput: + schema: + properties: + cachedimage: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cachedimage_GetPropertyDistinctFieldOutput: {} + cachedimage_GetPropertyDomainStatisticsOutput: + schema: + properties: + cachedimage: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + cachedimage_GetPropertyProjectStatisticsOutput: + schema: + properties: + cachedimage: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + cachedimage_GetPropertyProjectTagValuePairsOutput: {} + cachedimage_GetPropertyProjectTagValueTreeOutput: {} + cachedimage_GetPropertySplitableExportOutput: {} + cachedimage_GetPropertySplitableOutput: {} + cachedimage_GetPropertyStatisticsOutput: + schema: + properties: + cachedimage: + $ref: '#/definitions/StatusStatistic' + type: object + cachedimage_GetPropertyTagValuePairsOutput: {} + cachedimage_GetPropertyTagValueTreeOutput: {} + cachedimage_ListItemFilterOutput: + schema: + properties: + cachedimages: + items: + $ref: '#/definitions/CachedimageDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cachedimage_PerformCacheImageOutput: {} + cachedimage_PerformCancelDeleteOutput: {} + cachedimage_PerformChangeOwnerOutput: {} + cachedimage_PerformClassMetadataOutput: {} + cachedimage_PerformFreezeOutput: {} + cachedimage_PerformPrivateOutput: {} + cachedimage_PerformPublicOutput: {} + cachedimage_PerformPurgeSplitableOutput: {} + cachedimage_PerformRefreshOutput: {} + cachedimage_PerformSetClassMetadataOutput: {} + cachedimage_PerformSetUserMetadataOutput: {} + cachedimage_PerformStatusOutput: {} + cachedimage_PerformUncacheImageOutput: {} + cachedimage_PerformUnfreezeOutput: {} + cachedimage_ValidateCreateDataOutput: + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedimageDetails' + type: object + cachedimage_ValidateUpdateDataOutput: + schema: + properties: + cachedimage: + $ref: '#/definitions/CachedimageDetails' + type: object + cdn_domain_CustomizeDeleteOutput: + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainDetails' + type: object + cdn_domain_FetchCustomizeColumnsOutput: + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainDetails' + type: object + cdn_domain_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + cdn_domain: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cdn_domain_GetDetailsClassMetadataOutput: + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cdn_domain_GetDetailsMetadataOutput: + schema: + properties: + cdn_domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cdn_domain_GetDetailsStatusOutput: + schema: + properties: + cdn_domain: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cdn_domain_GetPropertyDistinctFieldOutput: {} + cdn_domain_GetPropertyDomainStatisticsOutput: + schema: + properties: + cdn_domain: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + cdn_domain_GetPropertyProjectStatisticsOutput: + schema: + properties: + cdn_domain: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + cdn_domain_GetPropertyProjectTagValuePairsOutput: {} + cdn_domain_GetPropertyProjectTagValueTreeOutput: {} + cdn_domain_GetPropertySplitableExportOutput: {} + cdn_domain_GetPropertySplitableOutput: {} + cdn_domain_GetPropertyStatisticsOutput: + schema: + properties: + cdn_domain: + $ref: '#/definitions/StatusStatistic' + type: object + cdn_domain_GetPropertyTagValuePairsOutput: {} + cdn_domain_GetPropertyTagValueTreeOutput: {} + cdn_domain_ListItemFilterOutput: + schema: + properties: + cdn_domains: + items: + $ref: '#/definitions/CDNDomainDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cdn_domain_PerformCancelDeleteOutput: {} + cdn_domain_PerformChangeOwnerOutput: {} + cdn_domain_PerformClassMetadataOutput: {} + cdn_domain_PerformDisableOutput: {} + cdn_domain_PerformEnableOutput: {} + cdn_domain_PerformFreezeOutput: {} + cdn_domain_PerformPurgeSplitableOutput: {} + cdn_domain_PerformRemoteUpdateOutput: {} + cdn_domain_PerformSetClassMetadataOutput: {} + cdn_domain_PerformSetUserMetadataOutput: {} + cdn_domain_PerformStatusOutput: {} + cdn_domain_PerformSyncstatusOutput: {} + cdn_domain_PerformUnfreezeOutput: {} + cdn_domain_ValidateCreateDataOutput: + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainDetails' + type: object + cdn_domain_ValidateUpdateDataOutput: + schema: + properties: + cdn_domain: + $ref: '#/definitions/CDNDomainDetails' + type: object + cloudaccount_CustomizeDeleteOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountDetail' + type: object + cloudaccount_FetchCustomizeColumnsOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountDetail' + type: object + cloudaccount_GetDetailsBalanceOutput: {} + cloudaccount_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudaccount_GetDetailsClassMetadataOutput: + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudaccount_GetDetailsEnrollmentAccountsOutput: + schema: + properties: + cloudaccount: + items: + $ref: '#/definitions/SEnrollmentAccount' + type: array + x-go-name: Output + type: object + cloudaccount_GetDetailsMetadataOutput: + schema: + properties: + cloudaccount: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudaccount_GetDetailsSamlOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/GetCloudaccountSamlOutput' + type: object + cloudaccount_GetDetailsStatusOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudaccount_GetPropertyDistinctFieldOutput: {} + cloudaccount_GetPropertyDomainTagValuePairsOutput: {} + cloudaccount_GetPropertyDomainTagValueTreeOutput: {} + cloudaccount_GetPropertySplitableExportOutput: {} + cloudaccount_GetPropertySplitableOutput: {} + cloudaccount_GetPropertyStatisticsOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/StatusStatistic' + type: object + cloudaccount_GetPropertyTagValuePairsOutput: {} + cloudaccount_GetPropertyTagValueTreeOutput: {} + cloudaccount_ListItemFilterOutput: + schema: + properties: + cloudaccounts: + items: + $ref: '#/definitions/CloudaccountDetail' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudaccount_PerformChangeProjectOutput: {} + cloudaccount_PerformClassMetadataOutput: {} + cloudaccount_PerformCreateSubscriptionOutput: {} + cloudaccount_PerformDisableOutput: {} + cloudaccount_PerformEnableOutput: {} + cloudaccount_PerformPrepareNetsOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountPerformPrepareNetsOutput' + type: object + cloudaccount_PerformPrivateOutput: {} + cloudaccount_PerformProjectMappingOutput: {} + cloudaccount_PerformPublicOutput: {} + cloudaccount_PerformPurgeSplitableOutput: {} + cloudaccount_PerformSetClassMetadataOutput: {} + cloudaccount_PerformSetUserMetadataOutput: {} + cloudaccount_PerformShareModeOutput: {} + cloudaccount_PerformStatusOutput: {} + cloudaccount_PerformSyncOutput: {} + cloudaccount_PerformSyncSkusOutput: {} + cloudaccount_PerformTestConnectivityOutput: {} + cloudaccount_PerformUpdateCredentialOutput: {} + cloudaccount_ValidateCreateDataOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountDetail' + type: object + cloudaccount_ValidateUpdateDataOutput: + schema: + properties: + cloudaccount: + $ref: '#/definitions/CloudaccountDetail' + type: object + cloudimage_CustomizeDeleteOutput: + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + cloudimage_FetchCustomizeColumnsOutput: + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + cloudimage_GetDetailsClassMetadataOutput: + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudimage_GetDetailsMetadataOutput: + schema: + properties: + cloudimage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudimage_GetPropertyDistinctFieldOutput: {} + cloudimage_GetPropertySplitableExportOutput: {} + cloudimage_GetPropertySplitableOutput: {} + cloudimage_GetPropertyTagValuePairsOutput: {} + cloudimage_GetPropertyTagValueTreeOutput: {} + cloudimage_ListItemFilterOutput: + schema: + properties: + cloudimages: + items: + $ref: '#/definitions/StandaloneResourceDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudimage_PerformClassMetadataOutput: {} + cloudimage_PerformPurgeSplitableOutput: {} + cloudimage_PerformSetClassMetadataOutput: {} + cloudimage_PerformSetUserMetadataOutput: {} + cloudimage_ValidateCreateDataOutput: + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + cloudimage_ValidateUpdateDataOutput: + schema: + properties: + cloudimage: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + cloudprovider_CustomizeDeleteOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderDetails' + type: object + cloudprovider_FetchCustomizeColumnsOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderDetails' + type: object + cloudprovider_GetDetailsCannedAclsOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderGetCannedAclOutput' + type: object + cloudprovider_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + cloudprovider_GetDetailsClassMetadataOutput: + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsClircOutput: {} + cloudprovider_GetDetailsMetadataOutput: + schema: + properties: + cloudprovider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudprovider_GetDetailsStatusOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudprovider_GetDetailsStorageClassesOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderGetStorageClassOutput' + type: object + cloudprovider_GetPropertyDistinctFieldOutput: {} + cloudprovider_GetPropertySplitableExportOutput: {} + cloudprovider_GetPropertySplitableOutput: {} + cloudprovider_GetPropertyStatisticsOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/StatusStatistic' + type: object + cloudprovider_GetPropertyTagValuePairsOutput: {} + cloudprovider_GetPropertyTagValueTreeOutput: {} + cloudprovider_ListItemFilterOutput: + schema: + properties: + cloudproviders: + items: + $ref: '#/definitions/CloudproviderDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudprovider_PerformChangeProjectOutput: {} + cloudprovider_PerformClassMetadataOutput: {} + cloudprovider_PerformDisableOutput: {} + cloudprovider_PerformEnableOutput: {} + cloudprovider_PerformProjectMappingOutput: {} + cloudprovider_PerformPurgeSplitableOutput: {} + cloudprovider_PerformSetClassMetadataOutput: {} + cloudprovider_PerformSetSchedtagOutput: {} + cloudprovider_PerformSetSyncingOutput: {} + cloudprovider_PerformSetUserMetadataOutput: {} + cloudprovider_PerformStatusOutput: {} + cloudprovider_PerformSyncOutput: {} + cloudprovider_ValidateUpdateDataOutput: + schema: + properties: + cloudprovider: + $ref: '#/definitions/CloudproviderDetails' + type: object + cloudproviderregion_CustomizeDeleteOutput: + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/CloudproviderregionDetails' + type: object + cloudproviderregion_FetchCustomizeColumnsOutput: + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/CloudproviderregionDetails' + type: object + cloudproviderregion_GetPropertyDistinctFieldOutput: {} + cloudproviderregion_GetPropertySplitableExportOutput: {} + cloudproviderregion_GetPropertySplitableOutput: {} + cloudproviderregion_ListItemFilterOutput: + schema: + properties: + cloudproviderregions: + items: + $ref: '#/definitions/CloudproviderregionDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudproviderregion_PerformPurgeSplitableOutput: {} + cloudproviderregion_ValidateCreateDataOutput: + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/CloudproviderregionDetails' + type: object + cloudproviderregion_ValidateUpdateDataOutput: + schema: + properties: + cloudproviderregion: + $ref: '#/definitions/CloudproviderregionDetails' + type: object + cloudregion_CustomizeDeleteOutput: + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionDetails' + type: object + cloudregion_FetchCustomizeColumnsOutput: + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionDetails' + type: object + cloudregion_GetDetailsCapabilityOutput: {} + cloudregion_GetDetailsClassMetadataOutput: + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudregion_GetDetailsDiskCapabilityOutput: {} + cloudregion_GetDetailsMetadataOutput: + schema: + properties: + cloudregion: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + cloudregion_GetDetailsStatusOutput: + schema: + properties: + cloudregion: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + cloudregion_GetPropertyDistinctFieldOutput: {} + cloudregion_GetPropertySplitableExportOutput: {} + cloudregion_GetPropertySplitableOutput: {} + cloudregion_GetPropertyStatisticsOutput: + schema: + properties: + cloudregion: + $ref: '#/definitions/StatusStatistic' + type: object + cloudregion_GetPropertySyncTasksOutput: {} + cloudregion_GetPropertyTagValuePairsOutput: {} + cloudregion_GetPropertyTagValueTreeOutput: {} + cloudregion_ListItemFilterOutput: + schema: + properties: + cloudregions: + items: + $ref: '#/definitions/CloudregionDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + cloudregion_PerformClassMetadataOutput: {} + cloudregion_PerformDefaultVpcOutput: {} + cloudregion_PerformDisableOutput: {} + cloudregion_PerformEnableOutput: {} + cloudregion_PerformPurgeSplitableOutput: {} + cloudregion_PerformSetClassMetadataOutput: {} + cloudregion_PerformSetSchedtagOutput: {} + cloudregion_PerformSetUserMetadataOutput: {} + cloudregion_PerformStatusOutput: {} + cloudregion_PerformSyncImagesOutput: {} + cloudregion_PerformSyncSkusOutput: {} + cloudregion_ValidateCreateDataOutput: + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionDetails' + type: object + cloudregion_ValidateUpdateDataOutput: + schema: + properties: + cloudregion: + $ref: '#/definitions/CloudregionDetails' + type: object + db_instance_CustomizeDeleteOutput: + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceDetails' + type: object + db_instance_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceDetails' + type: object + db_instance_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + db_instance: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + db_instance_GetDetailsClassMetadataOutput: + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_GetDetailsMetadataOutput: + schema: + properties: + db_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_GetDetailsStatusOutput: + schema: + properties: + db_instance: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_GetPropertyDistinctFieldOutput: {} + db_instance_GetPropertyDomainStatisticsOutput: + schema: + properties: + db_instance: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + db_instance_GetPropertyProjectStatisticsOutput: + schema: + properties: + db_instance: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + db_instance_GetPropertyProjectTagValuePairsOutput: {} + db_instance_GetPropertyProjectTagValueTreeOutput: {} + db_instance_GetPropertySplitableExportOutput: {} + db_instance_GetPropertySplitableOutput: {} + db_instance_GetPropertyStatisticsOutput: + schema: + properties: + db_instance: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_GetPropertyTagValuePairsOutput: {} + db_instance_GetPropertyTagValueTreeOutput: {} + db_instance_ListItemFilterOutput: + schema: + properties: + db_instances: + items: + $ref: '#/definitions/DBInstanceDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_PerformCancelDeleteOutput: {} + db_instance_PerformCancelExpireOutput: {} + db_instance_PerformChangeConfigOutput: {} + db_instance_PerformChangeOwnerOutput: {} + db_instance_PerformClassMetadataOutput: {} + db_instance_PerformFreezeOutput: {} + db_instance_PerformPostpaidExpireOutput: {} + db_instance_PerformPublicConnectionOutput: {} + db_instance_PerformPurgeOutput: {} + db_instance_PerformPurgeSplitableOutput: {} + db_instance_PerformRebootOutput: {} + db_instance_PerformRecoveryOutput: {} + db_instance_PerformRemoteUpdateOutput: {} + db_instance_PerformRenewOutput: {} + db_instance_PerformSetAutoRenewOutput: {} + db_instance_PerformSetClassMetadataOutput: {} + db_instance_PerformSetSecgroupOutput: {} + db_instance_PerformSetUserMetadataOutput: {} + db_instance_PerformStatusOutput: {} + db_instance_PerformSyncOutput: {} + db_instance_PerformSyncStatusOutput: {} + db_instance_PerformSyncstatusOutput: {} + db_instance_PerformUnfreezeOutput: {} + db_instance_ValidateCreateDataOutput: + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceDetails' + type: object + db_instance_ValidateUpdateDataOutput: + schema: + properties: + db_instance: + $ref: '#/definitions/DBInstanceDetails' + type: object + db_instance_account_CustomizeDeleteOutput: + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountDetails' + type: object + db_instance_account_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountDetails' + type: object + db_instance_account_GetDetailsClassMetadataOutput: + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_account_GetDetailsMetadataOutput: + schema: + properties: + db_instance_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_account_GetDetailsStatusOutput: + schema: + properties: + db_instance_account: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_account_GetPropertyDistinctFieldOutput: {} + db_instance_account_GetPropertySplitableExportOutput: {} + db_instance_account_GetPropertySplitableOutput: {} + db_instance_account_GetPropertyStatisticsOutput: + schema: + properties: + db_instance_account: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_account_GetPropertyTagValuePairsOutput: {} + db_instance_account_GetPropertyTagValueTreeOutput: {} + db_instance_account_ListItemFilterOutput: + schema: + properties: + db_instance_accounts: + items: + $ref: '#/definitions/DBInstanceAccountDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_account_PerformClassMetadataOutput: {} + db_instance_account_PerformGrantPrivilegeOutput: {} + db_instance_account_PerformPurgeSplitableOutput: {} + db_instance_account_PerformResetPasswordOutput: {} + db_instance_account_PerformRevokePrivilegeOutput: {} + db_instance_account_PerformSetClassMetadataOutput: {} + db_instance_account_PerformSetPrivilegesOutput: {} + db_instance_account_PerformSetUserMetadataOutput: {} + db_instance_account_PerformStatusOutput: {} + db_instance_account_ValidateCreateDataOutput: + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountDetails' + type: object + db_instance_account_ValidateUpdateDataOutput: + schema: + properties: + db_instance_account: + $ref: '#/definitions/DBInstanceAccountDetails' + type: object + db_instance_backup_CustomizeDeleteOutput: + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupDetails' + type: object + db_instance_backup_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupDetails' + type: object + db_instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + db_instance_backup: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + db_instance_backup_GetDetailsClassMetadataOutput: + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_backup_GetDetailsMetadataOutput: + schema: + properties: + db_instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_backup_GetDetailsStatusOutput: + schema: + properties: + db_instance_backup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_backup_GetPropertyDistinctFieldOutput: {} + db_instance_backup_GetPropertyDomainStatisticsOutput: + schema: + properties: + db_instance_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + db_instance_backup_GetPropertyProjectStatisticsOutput: + schema: + properties: + db_instance_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + db_instance_backup_GetPropertyProjectTagValuePairsOutput: {} + db_instance_backup_GetPropertyProjectTagValueTreeOutput: {} + db_instance_backup_GetPropertySplitableExportOutput: {} + db_instance_backup_GetPropertySplitableOutput: {} + db_instance_backup_GetPropertyStatisticsOutput: + schema: + properties: + db_instance_backup: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_backup_GetPropertyTagValuePairsOutput: {} + db_instance_backup_GetPropertyTagValueTreeOutput: {} + db_instance_backup_ListItemFilterOutput: + schema: + properties: + db_instance_backups: + items: + $ref: '#/definitions/DBInstanceBackupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_backup_PerformCancelDeleteOutput: {} + db_instance_backup_PerformChangeOwnerOutput: {} + db_instance_backup_PerformClassMetadataOutput: {} + db_instance_backup_PerformFreezeOutput: {} + db_instance_backup_PerformPurgeSplitableOutput: {} + db_instance_backup_PerformSetClassMetadataOutput: {} + db_instance_backup_PerformSetUserMetadataOutput: {} + db_instance_backup_PerformStatusOutput: {} + db_instance_backup_PerformSyncstatusOutput: {} + db_instance_backup_PerformUnfreezeOutput: {} + db_instance_backup_ValidateCreateDataOutput: + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupDetails' + type: object + db_instance_backup_ValidateUpdateDataOutput: + schema: + properties: + db_instance_backup: + $ref: '#/definitions/DBInstanceBackupDetails' + type: object + db_instance_database_CustomizeDeleteOutput: + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: object + db_instance_database_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: object + db_instance_database_GetDetailsClassMetadataOutput: + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_database_GetDetailsMetadataOutput: + schema: + properties: + db_instance_database: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_database_GetDetailsStatusOutput: + schema: + properties: + db_instance_database: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_database_GetPropertyDistinctFieldOutput: {} + db_instance_database_GetPropertySplitableExportOutput: {} + db_instance_database_GetPropertySplitableOutput: {} + db_instance_database_GetPropertyStatisticsOutput: + schema: + properties: + db_instance_database: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_database_GetPropertyTagValuePairsOutput: {} + db_instance_database_GetPropertyTagValueTreeOutput: {} + db_instance_database_ListItemFilterOutput: + schema: + properties: + db_instance_databases: + items: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_database_PerformClassMetadataOutput: {} + db_instance_database_PerformPurgeSplitableOutput: {} + db_instance_database_PerformSetClassMetadataOutput: {} + db_instance_database_PerformSetUserMetadataOutput: {} + db_instance_database_PerformStatusOutput: {} + db_instance_database_ValidateCreateDataOutput: + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: object + db_instance_database_ValidateUpdateDataOutput: + schema: + properties: + db_instance_database: + $ref: '#/definitions/DBInstancedatabaseDetails' + type: object + db_instance_network_CustomizeDeleteOutput: + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + db_instance_network_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + db_instance_network_GetPropertyDistinctFieldOutput: {} + db_instance_network_GetPropertySplitableExportOutput: {} + db_instance_network_GetPropertySplitableOutput: {} + db_instance_network_ListItemFilterOutput: + schema: + properties: + db_instance_networks: + items: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_network_PerformPurgeSplitableOutput: {} + db_instance_network_ValidateCreateDataOutput: + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + db_instance_network_ValidateUpdateDataOutput: + schema: + properties: + db_instance_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + db_instance_parameter_CustomizeDeleteOutput: + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/DBInstanceparameterDetails' + type: object + db_instance_parameter_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/DBInstanceparameterDetails' + type: object + db_instance_parameter_GetDetailsClassMetadataOutput: + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_parameter_GetDetailsMetadataOutput: + schema: + properties: + db_instance_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_parameter_GetPropertyDistinctFieldOutput: {} + db_instance_parameter_GetPropertySplitableExportOutput: {} + db_instance_parameter_GetPropertySplitableOutput: {} + db_instance_parameter_GetPropertyTagValuePairsOutput: {} + db_instance_parameter_GetPropertyTagValueTreeOutput: {} + db_instance_parameter_ListItemFilterOutput: + schema: + properties: + db_instance_parameters: + items: + $ref: '#/definitions/DBInstanceparameterDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_parameter_PerformClassMetadataOutput: {} + db_instance_parameter_PerformPurgeSplitableOutput: {} + db_instance_parameter_PerformSetClassMetadataOutput: {} + db_instance_parameter_PerformSetUserMetadataOutput: {} + db_instance_parameter_ValidateCreateDataOutput: + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/DBInstanceparameterDetails' + type: object + db_instance_parameter_ValidateUpdateDataOutput: + schema: + properties: + db_instance_parameter: + $ref: '#/definitions/DBInstanceparameterDetails' + type: object + db_instance_privilege_CustomizeDeleteOutput: + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseDetails' + type: object + db_instance_privilege_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseDetails' + type: object + db_instance_privilege_GetPropertyDistinctFieldOutput: {} + db_instance_privilege_GetPropertySplitableExportOutput: {} + db_instance_privilege_GetPropertySplitableOutput: {} + db_instance_privilege_ListItemFilterOutput: + schema: + properties: + db_instance_privileges: + items: + $ref: '#/definitions/ResourceBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_privilege_PerformPurgeSplitableOutput: {} + db_instance_privilege_ValidateCreateDataOutput: + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseDetails' + type: object + db_instance_privilege_ValidateUpdateDataOutput: + schema: + properties: + db_instance_privilege: + $ref: '#/definitions/ResourceBaseDetails' + type: object + db_instance_secgroup_CustomizeDeleteOutput: + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: object + db_instance_secgroup_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: object + db_instance_secgroup_GetPropertyDistinctFieldOutput: {} + db_instance_secgroup_GetPropertySplitableExportOutput: {} + db_instance_secgroup_GetPropertySplitableOutput: {} + db_instance_secgroup_ListItemFilterOutput: + schema: + properties: + db_instance_secgroups: + items: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_secgroup_PerformPurgeSplitableOutput: {} + db_instance_secgroup_ValidateCreateDataOutput: + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: object + db_instance_secgroup_ValidateUpdateDataOutput: + schema: + properties: + db_instance_secgroup: + $ref: '#/definitions/DBInstanceSecgroupDetails' + type: object + db_instance_sku_CustomizeDeleteOutput: + schema: + properties: + db_instance_sku: + $ref: '#/definitions/DBInstanceSkuDetails' + type: object + db_instance_sku_FetchCustomizeColumnsOutput: + schema: + properties: + db_instance_sku: + $ref: '#/definitions/DBInstanceSkuDetails' + type: object + db_instance_sku_GetDetailsClassMetadataOutput: + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_sku_GetDetailsMetadataOutput: + schema: + properties: + db_instance_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + db_instance_sku_GetDetailsStatusOutput: + schema: + properties: + db_instance_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + db_instance_sku_GetPropertyDistinctFieldOutput: {} + db_instance_sku_GetPropertyInstanceSpecsOutput: {} + db_instance_sku_GetPropertySplitableExportOutput: {} + db_instance_sku_GetPropertySplitableOutput: {} + db_instance_sku_GetPropertyStatisticsOutput: + schema: + properties: + db_instance_sku: + $ref: '#/definitions/StatusStatistic' + type: object + db_instance_sku_GetPropertySyncTasksOutput: {} + db_instance_sku_GetPropertyTagValuePairsOutput: {} + db_instance_sku_GetPropertyTagValueTreeOutput: {} + db_instance_sku_ListItemFilterOutput: + schema: + properties: + db_instance_skus: + items: + $ref: '#/definitions/DBInstanceSkuDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + db_instance_sku_PerformClassMetadataOutput: {} + db_instance_sku_PerformDisableOutput: {} + db_instance_sku_PerformEnableOutput: {} + db_instance_sku_PerformPurgeSplitableOutput: {} + db_instance_sku_PerformSetClassMetadataOutput: {} + db_instance_sku_PerformSetUserMetadataOutput: {} + db_instance_sku_PerformStatusOutput: {} + db_instance_sku_PerformSyncSkusOutput: {} + db_instance_sku_ValidateCreateDataOutput: + schema: + properties: + db_instance_sku: + $ref: '#/definitions/DBInstanceSkuDetails' + type: object + db_instance_sku_ValidateUpdateDataOutput: + schema: + properties: + db_instance_sku: + $ref: '#/definitions/DBInstanceSkuDetails' + type: object + disk_CustomizeDeleteOutput: + schema: + properties: + disk: + $ref: '#/definitions/DiskDetails' + type: object + disk_FetchCustomizeColumnsOutput: + schema: + properties: + disk: + $ref: '#/definitions/DiskDetails' + type: object + disk_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + disk: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + disk_GetDetailsClassMetadataOutput: + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_GetDetailsConvertSnapshotOutput: {} + disk_GetDetailsMetadataOutput: + schema: + properties: + disk: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_GetDetailsStatusOutput: + schema: + properties: + disk: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + disk_GetPropertyDistinctFieldOutput: {} + disk_GetPropertyDomainStatisticsOutput: + schema: + properties: + disk: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + disk_GetPropertyProjectStatisticsOutput: + schema: + properties: + disk: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + disk_GetPropertyProjectTagValuePairsOutput: {} + disk_GetPropertyProjectTagValueTreeOutput: {} + disk_GetPropertySplitableExportOutput: {} + disk_GetPropertySplitableOutput: {} + disk_GetPropertyStatisticsOutput: + schema: + properties: + disk: + $ref: '#/definitions/StatusStatistic' + type: object + disk_GetPropertyTagValuePairsOutput: {} + disk_GetPropertyTagValueTreeOutput: {} + disk_ListItemFilterOutput: + schema: + properties: + disks: + items: + $ref: '#/definitions/DiskDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + disk_PerformBindSnapshotpolicyOutput: {} + disk_PerformCancelDeleteOutput: {} + disk_PerformChangeOwnerOutput: {} + disk_PerformClassMetadataOutput: {} + disk_PerformDiskResetOutput: {} + disk_PerformFreezeOutput: {} + disk_PerformPurgeOutput: {} + disk_PerformPurgeSplitableOutput: {} + disk_PerformResizeOutput: {} + disk_PerformSaveOutput: {} + disk_PerformSetClassMetadataOutput: {} + disk_PerformSetUserMetadataOutput: {} + disk_PerformStatusOutput: {} + disk_PerformSyncstatusOutput: {} + disk_PerformUnbindSnapshotpolicyOutput: {} + disk_PerformUnfreezeOutput: {} + disk_ValidateCreateDataOutput: + schema: + properties: + disk: + $ref: '#/definitions/DiskDetails' + type: object + disk_ValidateUpdateDataOutput: + schema: + properties: + disk: + $ref: '#/definitions/DiskDetails' + type: object + disk_backup_CustomizeDeleteOutput: + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupDetails' + type: object + disk_backup_FetchCustomizeColumnsOutput: + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupDetails' + type: object + disk_backup_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + disk_backup: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + disk_backup_GetDetailsClassMetadataOutput: + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_backup_GetDetailsMetadataOutput: + schema: + properties: + disk_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + disk_backup_GetDetailsStatusOutput: + schema: + properties: + disk_backup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + disk_backup_GetPropertyDistinctFieldOutput: {} + disk_backup_GetPropertyDomainStatisticsOutput: + schema: + properties: + disk_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + disk_backup_GetPropertyProjectStatisticsOutput: + schema: + properties: + disk_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + disk_backup_GetPropertyProjectTagValuePairsOutput: {} + disk_backup_GetPropertyProjectTagValueTreeOutput: {} + disk_backup_GetPropertySplitableExportOutput: {} + disk_backup_GetPropertySplitableOutput: {} + disk_backup_GetPropertyStatisticsOutput: + schema: + properties: + disk_backup: + $ref: '#/definitions/StatusStatistic' + type: object + disk_backup_GetPropertyTagValuePairsOutput: {} + disk_backup_GetPropertyTagValueTreeOutput: {} + disk_backup_ListItemFilterOutput: + schema: + properties: + disk_backups: + items: + $ref: '#/definitions/DiskBackupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + disk_backup_PerformCancelDeleteOutput: {} + disk_backup_PerformChangeOwnerOutput: {} + disk_backup_PerformClassMetadataOutput: {} + disk_backup_PerformFreezeOutput: {} + disk_backup_PerformPurgeSplitableOutput: {} + disk_backup_PerformRecoveryOutput: {} + disk_backup_PerformSetClassMetadataOutput: {} + disk_backup_PerformSetUserMetadataOutput: {} + disk_backup_PerformStatusOutput: {} + disk_backup_PerformSyncstatusOutput: {} + disk_backup_PerformUnfreezeOutput: {} + disk_backup_ValidateCreateDataOutput: + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupDetails' + type: object + disk_backup_ValidateUpdateDataOutput: + schema: + properties: + disk_backup: + $ref: '#/definitions/DiskBackupDetails' + type: object + dns_record_CustomizeDeleteOutput: + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDetails' + type: object + dns_record_FetchCustomizeColumnsOutput: + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDetails' + type: object + dns_record_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + dns_record: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + dns_record_GetDetailsClassMetadataOutput: + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_record_GetDetailsMetadataOutput: + schema: + properties: + dns_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_record_GetDetailsStatusOutput: + schema: + properties: + dns_record: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + dns_record_GetPropertyDistinctFieldOutput: {} + dns_record_GetPropertyDomainStatisticsOutput: + schema: + properties: + dns_record: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + dns_record_GetPropertyProjectStatisticsOutput: + schema: + properties: + dns_record: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + dns_record_GetPropertyProjectTagValuePairsOutput: {} + dns_record_GetPropertyProjectTagValueTreeOutput: {} + dns_record_GetPropertySplitableExportOutput: {} + dns_record_GetPropertySplitableOutput: {} + dns_record_GetPropertyStatisticsOutput: + schema: + properties: + dns_record: + $ref: '#/definitions/StatusStatistic' + type: object + dns_record_GetPropertyTagValuePairsOutput: {} + dns_record_GetPropertyTagValueTreeOutput: {} + dns_record_ListItemFilterOutput: + schema: + properties: + dns_records: + items: + $ref: '#/definitions/DnsRecordDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + dns_record_PerformAddRecordsOutput: {} + dns_record_PerformCancelDeleteOutput: {} + dns_record_PerformChangeOwnerOutput: {} + dns_record_PerformClassMetadataOutput: {} + dns_record_PerformDisableOutput: {} + dns_record_PerformEnableOutput: {} + dns_record_PerformFreezeOutput: {} + dns_record_PerformPrivateOutput: {} + dns_record_PerformPublicOutput: {} + dns_record_PerformPurgeSplitableOutput: {} + dns_record_PerformRemoveRecordsOutput: {} + dns_record_PerformSetClassMetadataOutput: {} + dns_record_PerformSetUserMetadataOutput: {} + dns_record_PerformStatusOutput: {} + dns_record_PerformUnfreezeOutput: {} + dns_record_ValidateCreateDataOutput: + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDetails' + type: object + dns_record_ValidateUpdateDataOutput: + schema: + properties: + dns_record: + $ref: '#/definitions/DnsRecordDetails' + type: object + dns_record_set_traffic_policy_CustomizeDeleteOutput: + schema: + properties: + dns_record_set_traffic_policy: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_record_set_traffic_policy_FetchCustomizeColumnsOutput: + schema: + properties: + dns_record_set_traffic_policy: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_record_set_traffic_policy_GetPropertyDistinctFieldOutput: {} + dns_record_set_traffic_policy_GetPropertySplitableExportOutput: {} + dns_record_set_traffic_policy_GetPropertySplitableOutput: {} + dns_record_set_traffic_policy_ListItemFilterOutput: + schema: + properties: + dns_record_set_traffic_policies: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + dns_record_set_traffic_policy_PerformPurgeSplitableOutput: {} + dns_record_set_traffic_policy_ValidateCreateDataOutput: + schema: + properties: + dns_record_set_traffic_policy: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_record_set_traffic_policy_ValidateUpdateDataOutput: + schema: + properties: + dns_record_set_traffic_policy: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_recordset_CustomizeDeleteOutput: + schema: + properties: + dns_recordset: + $ref: '#/definitions/DnsRecordSetDetails' + type: object + dns_recordset_FetchCustomizeColumnsOutput: + schema: + properties: + dns_recordset: + $ref: '#/definitions/DnsRecordSetDetails' + type: object + dns_recordset_GetDetailsClassMetadataOutput: + schema: + properties: + dns_recordset: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_recordset_GetDetailsMetadataOutput: + schema: + properties: + dns_recordset: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_recordset_GetDetailsStatusOutput: + schema: + properties: + dns_recordset: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + dns_recordset_GetPropertyDistinctFieldOutput: {} + dns_recordset_GetPropertySplitableExportOutput: {} + dns_recordset_GetPropertySplitableOutput: {} + dns_recordset_GetPropertyStatisticsOutput: + schema: + properties: + dns_recordset: + $ref: '#/definitions/StatusStatistic' + type: object + dns_recordset_GetPropertyTagValuePairsOutput: {} + dns_recordset_GetPropertyTagValueTreeOutput: {} + dns_recordset_ListItemFilterOutput: + schema: + properties: + dns_recordsets: + items: + $ref: '#/definitions/DnsRecordSetDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + dns_recordset_PerformClassMetadataOutput: {} + dns_recordset_PerformDisableOutput: {} + dns_recordset_PerformEnableOutput: {} + dns_recordset_PerformPurgeSplitableOutput: {} + dns_recordset_PerformSetClassMetadataOutput: {} + dns_recordset_PerformSetTrafficPoliciesOutput: {} + dns_recordset_PerformSetUserMetadataOutput: {} + dns_recordset_PerformStatusOutput: {} + dns_recordset_ValidateCreateDataOutput: + schema: + properties: + dns_recordset: + $ref: '#/definitions/DnsRecordSetDetails' + type: object + dns_recordset_ValidateUpdateDataOutput: + schema: + properties: + dns_recordset: + $ref: '#/definitions/DnsRecordSetDetails' + type: object + dns_traffic_policy_CustomizeDeleteOutput: + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/DnsTrafficPolicyDetails' + type: object + dns_traffic_policy_FetchCustomizeColumnsOutput: + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/DnsTrafficPolicyDetails' + type: object + dns_traffic_policy_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + dns_traffic_policy_GetDetailsClassMetadataOutput: + schema: + properties: + dns_traffic_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_traffic_policy_GetDetailsMetadataOutput: + schema: + properties: + dns_traffic_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_traffic_policy_GetDetailsStatusOutput: + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + dns_traffic_policy_GetPropertyDistinctFieldOutput: {} + dns_traffic_policy_GetPropertyDomainTagValuePairsOutput: {} + dns_traffic_policy_GetPropertyDomainTagValueTreeOutput: {} + dns_traffic_policy_GetPropertySplitableExportOutput: {} + dns_traffic_policy_GetPropertySplitableOutput: {} + dns_traffic_policy_GetPropertyStatisticsOutput: + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/StatusStatistic' + type: object + dns_traffic_policy_GetPropertyTagValuePairsOutput: {} + dns_traffic_policy_GetPropertyTagValueTreeOutput: {} + dns_traffic_policy_ListItemFilterOutput: + schema: + properties: + dns_traffic_policies: + items: + $ref: '#/definitions/DnsTrafficPolicyDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + dns_traffic_policy_PerformChangeOwnerOutput: {} + dns_traffic_policy_PerformClassMetadataOutput: {} + dns_traffic_policy_PerformDisableOutput: {} + dns_traffic_policy_PerformEnableOutput: {} + dns_traffic_policy_PerformPrivateOutput: {} + dns_traffic_policy_PerformPublicOutput: {} + dns_traffic_policy_PerformPurgeSplitableOutput: {} + dns_traffic_policy_PerformSetClassMetadataOutput: {} + dns_traffic_policy_PerformSetUserMetadataOutput: {} + dns_traffic_policy_PerformStatusOutput: {} + dns_traffic_policy_ValidateCreateDataOutput: + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/DnsTrafficPolicyDetails' + type: object + dns_traffic_policy_ValidateUpdateDataOutput: + schema: + properties: + dns_traffic_policy: + $ref: '#/definitions/DnsTrafficPolicyDetails' + type: object + dns_zone_CustomizeDeleteOutput: + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneDetails' + type: object + dns_zone_FetchCustomizeColumnsOutput: + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneDetails' + type: object + dns_zone_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + dns_zone: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + dns_zone_GetDetailsClassMetadataOutput: + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_zone_GetDetailsExportsOutput: {} + dns_zone_GetDetailsMetadataOutput: + schema: + properties: + dns_zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_zone_GetDetailsStatusOutput: + schema: + properties: + dns_zone: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + dns_zone_GetPropertyCapabilityOutput: {} + dns_zone_GetPropertyDistinctFieldOutput: {} + dns_zone_GetPropertyDomainTagValuePairsOutput: {} + dns_zone_GetPropertyDomainTagValueTreeOutput: {} + dns_zone_GetPropertySplitableExportOutput: {} + dns_zone_GetPropertySplitableOutput: {} + dns_zone_GetPropertyStatisticsOutput: + schema: + properties: + dns_zone: + $ref: '#/definitions/StatusStatistic' + type: object + dns_zone_GetPropertyTagValuePairsOutput: {} + dns_zone_GetPropertyTagValueTreeOutput: {} + dns_zone_ListItemFilterOutput: + schema: + properties: + dns_zones: + items: + $ref: '#/definitions/DnsZoneDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + dns_zone_PerformAddVpcsOutput: {} + dns_zone_PerformCacheOutput: {} + dns_zone_PerformChangeOwnerOutput: {} + dns_zone_PerformClassMetadataOutput: {} + dns_zone_PerformDisableOutput: {} + dns_zone_PerformEnableOutput: {} + dns_zone_PerformPrivateOutput: {} + dns_zone_PerformPublicOutput: {} + dns_zone_PerformPurgeOutput: {} + dns_zone_PerformPurgeSplitableOutput: {} + dns_zone_PerformRemoveVpcsOutput: {} + dns_zone_PerformSetClassMetadataOutput: {} + dns_zone_PerformSetUserMetadataOutput: {} + dns_zone_PerformStatusOutput: {} + dns_zone_PerformSyncRecordsetsOutput: {} + dns_zone_PerformSyncstatusOutput: {} + dns_zone_PerformUncacheOutput: {} + dns_zone_ValidateCreateDataOutput: + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneDetails' + type: object + dns_zone_ValidateUpdateDataOutput: + schema: + properties: + dns_zone: + $ref: '#/definitions/DnsZoneDetails' + type: object + dns_zone_cache_CustomizeDeleteOutput: + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/DnsZoneCacheDetails' + type: object + dns_zone_cache_FetchCustomizeColumnsOutput: + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/DnsZoneCacheDetails' + type: object + dns_zone_cache_GetDetailsClassMetadataOutput: + schema: + properties: + dns_zone_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_zone_cache_GetDetailsMetadataOutput: + schema: + properties: + dns_zone_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dns_zone_cache_GetDetailsStatusOutput: + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + dns_zone_cache_GetPropertyDistinctFieldOutput: {} + dns_zone_cache_GetPropertySplitableExportOutput: {} + dns_zone_cache_GetPropertySplitableOutput: {} + dns_zone_cache_GetPropertyStatisticsOutput: + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/StatusStatistic' + type: object + dns_zone_cache_GetPropertyTagValuePairsOutput: {} + dns_zone_cache_GetPropertyTagValueTreeOutput: {} + dns_zone_cache_ListItemFilterOutput: + schema: + properties: + dns_zone_caches: + items: + $ref: '#/definitions/DnsZoneCacheDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + dns_zone_cache_PerformClassMetadataOutput: {} + dns_zone_cache_PerformPurgeSplitableOutput: {} + dns_zone_cache_PerformSetClassMetadataOutput: {} + dns_zone_cache_PerformSetUserMetadataOutput: {} + dns_zone_cache_PerformStatusOutput: {} + dns_zone_cache_ValidateCreateDataOutput: + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/DnsZoneCacheDetails' + type: object + dns_zone_cache_ValidateUpdateDataOutput: + schema: + properties: + dns_zone_cache: + $ref: '#/definitions/DnsZoneCacheDetails' + type: object + dns_zone_vpc_CustomizeDeleteOutput: + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_zone_vpc_FetchCustomizeColumnsOutput: + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_zone_vpc_GetPropertyDistinctFieldOutput: {} + dns_zone_vpc_GetPropertySplitableExportOutput: {} + dns_zone_vpc_GetPropertySplitableOutput: {} + dns_zone_vpc_ListItemFilterOutput: + schema: + properties: + dns_zone_vpcs: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + dns_zone_vpc_PerformPurgeSplitableOutput: {} + dns_zone_vpc_ValidateCreateDataOutput: + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dns_zone_vpc_ValidateUpdateDataOutput: + schema: + properties: + dns_zone_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + dynamicschedtag_CustomizeDeleteOutput: + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/DynamicschedtagDetails' + type: object + dynamicschedtag_FetchCustomizeColumnsOutput: + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/DynamicschedtagDetails' + type: object + dynamicschedtag_GetDetailsClassMetadataOutput: + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dynamicschedtag_GetDetailsMetadataOutput: + schema: + properties: + dynamicschedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + dynamicschedtag_GetPropertyDistinctFieldOutput: {} + dynamicschedtag_GetPropertySplitableExportOutput: {} + dynamicschedtag_GetPropertySplitableOutput: {} + dynamicschedtag_GetPropertyTagValuePairsOutput: {} + dynamicschedtag_GetPropertyTagValueTreeOutput: {} + dynamicschedtag_ListItemFilterOutput: + schema: + properties: + dynamicschedtags: + items: + $ref: '#/definitions/DynamicschedtagDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + dynamicschedtag_PerformClassMetadataOutput: {} + dynamicschedtag_PerformEvaluateOutput: {} + dynamicschedtag_PerformPurgeSplitableOutput: {} + dynamicschedtag_PerformSetClassMetadataOutput: {} + dynamicschedtag_PerformSetUserMetadataOutput: {} + dynamicschedtag_ValidateCreateDataOutput: + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/DynamicschedtagDetails' + type: object + dynamicschedtag_ValidateUpdateDataOutput: + schema: + properties: + dynamicschedtag: + $ref: '#/definitions/DynamicschedtagDetails' + type: object + elastic_search_CustomizeDeleteOutput: + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchDetails' + type: object + elastic_search_FetchCustomizeColumnsOutput: + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchDetails' + type: object + elastic_search_GetDetailsAccessInfoOutput: + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchAccessInfo' + type: object + elastic_search_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + elastic_search: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + elastic_search_GetDetailsClassMetadataOutput: + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elastic_search_GetDetailsMetadataOutput: + schema: + properties: + elastic_search: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elastic_search_GetDetailsStatusOutput: + schema: + properties: + elastic_search: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elastic_search_GetPropertyDistinctFieldOutput: {} + elastic_search_GetPropertyDomainStatisticsOutput: + schema: + properties: + elastic_search: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elastic_search_GetPropertyProjectStatisticsOutput: + schema: + properties: + elastic_search: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elastic_search_GetPropertyProjectTagValuePairsOutput: {} + elastic_search_GetPropertyProjectTagValueTreeOutput: {} + elastic_search_GetPropertySplitableExportOutput: {} + elastic_search_GetPropertySplitableOutput: {} + elastic_search_GetPropertyStatisticsOutput: + schema: + properties: + elastic_search: + $ref: '#/definitions/StatusStatistic' + type: object + elastic_search_GetPropertyTagValuePairsOutput: {} + elastic_search_GetPropertyTagValueTreeOutput: {} + elastic_search_ListItemFilterOutput: + schema: + properties: + elastic_searches: + items: + $ref: '#/definitions/ElasticSearchDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elastic_search_PerformCancelDeleteOutput: {} + elastic_search_PerformChangeOwnerOutput: {} + elastic_search_PerformClassMetadataOutput: {} + elastic_search_PerformFreezeOutput: {} + elastic_search_PerformPurgeSplitableOutput: {} + elastic_search_PerformSetClassMetadataOutput: {} + elastic_search_PerformSetUserMetadataOutput: {} + elastic_search_PerformStatusOutput: {} + elastic_search_PerformSyncstatusOutput: {} + elastic_search_PerformUnfreezeOutput: {} + elastic_search_ValidateCreateDataOutput: + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchDetails' + type: object + elastic_search_ValidateUpdateDataOutput: + schema: + properties: + elastic_search: + $ref: '#/definitions/ElasticSearchDetails' + type: object + elasticcache_CustomizeDeleteOutput: + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheDetails' + type: object + elasticcache_FetchCustomizeColumnsOutput: + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheDetails' + type: object + elasticcache_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + elasticcache: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + elasticcache_GetDetailsClassMetadataOutput: + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_GetDetailsLoginInfoOutput: {} + elasticcache_GetDetailsMetadataOutput: + schema: + properties: + elasticcache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_GetDetailsStatusOutput: + schema: + properties: + elasticcache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_GetPropertyDistinctFieldOutput: {} + elasticcache_GetPropertyDomainStatisticsOutput: + schema: + properties: + elasticcache: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elasticcache_GetPropertyProjectStatisticsOutput: + schema: + properties: + elasticcache: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elasticcache_GetPropertyProjectTagValuePairsOutput: {} + elasticcache_GetPropertyProjectTagValueTreeOutput: {} + elasticcache_GetPropertySplitableExportOutput: {} + elasticcache_GetPropertySplitableOutput: {} + elasticcache_GetPropertyStatisticsOutput: + schema: + properties: + elasticcache: + $ref: '#/definitions/StatusStatistic' + type: object + elasticcache_GetPropertyTagValuePairsOutput: {} + elasticcache_GetPropertyTagValueTreeOutput: {} + elasticcache_ListItemFilterOutput: + schema: + properties: + elasticcaches: + items: + $ref: '#/definitions/ElasticcacheDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elasticcache_PerformAddSecgroupOutput: {} + elasticcache_PerformAllocatePublicConnectionOutput: {} + elasticcache_PerformCancelDeleteOutput: {} + elasticcache_PerformCancelExpireOutput: {} + elasticcache_PerformChangeOwnerOutput: {} + elasticcache_PerformChangeSpecOutput: {} + elasticcache_PerformClassMetadataOutput: {} + elasticcache_PerformFlushInstanceOutput: {} + elasticcache_PerformFreezeOutput: {} + elasticcache_PerformPostpaidExpireOutput: {} + elasticcache_PerformPurgeSplitableOutput: {} + elasticcache_PerformReleasePublicConnectionOutput: {} + elasticcache_PerformRemoteUpdateOutput: {} + elasticcache_PerformRenewOutput: {} + elasticcache_PerformResetPasswordOutput: {} + elasticcache_PerformRestartOutput: {} + elasticcache_PerformRevokeSecgroupOutput: {} + elasticcache_PerformSetAutoRenewOutput: {} + elasticcache_PerformSetClassMetadataOutput: {} + elasticcache_PerformSetMaintainTimeOutput: {} + elasticcache_PerformSetSecgroupOutput: {} + elasticcache_PerformSetUserMetadataOutput: {} + elasticcache_PerformStatusOutput: {} + elasticcache_PerformSyncOutput: {} + elasticcache_PerformSyncstatusOutput: {} + elasticcache_PerformUnfreezeOutput: {} + elasticcache_PerformUpdateAuthModeOutput: {} + elasticcache_PerformUpdateBackupPolicyOutput: {} + elasticcache_PerformUpdateInstanceParametersOutput: {} + elasticcache_ValidateCreateDataOutput: + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheDetails' + type: object + elasticcache_ValidateUpdateDataOutput: + schema: + properties: + elasticcache: + $ref: '#/definitions/ElasticcacheDetails' + type: object + elasticcache_account_CustomizeDeleteOutput: + schema: + properties: + elasticcache_account: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: object + elasticcache_account_FetchCustomizeColumnsOutput: + schema: + properties: + elasticcache_account: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: object + elasticcache_account_GetDetailsClassMetadataOutput: + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_account_GetDetailsLoginInfoOutput: {} + elasticcache_account_GetDetailsMetadataOutput: + schema: + properties: + elasticcache_account: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_account_GetDetailsStatusOutput: + schema: + properties: + elasticcache_account: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_account_GetPropertyDistinctFieldOutput: {} + elasticcache_account_GetPropertySplitableExportOutput: {} + elasticcache_account_GetPropertySplitableOutput: {} + elasticcache_account_GetPropertyStatisticsOutput: + schema: + properties: + elasticcache_account: + $ref: '#/definitions/StatusStatistic' + type: object + elasticcache_account_GetPropertyTagValuePairsOutput: {} + elasticcache_account_GetPropertyTagValueTreeOutput: {} + elasticcache_account_ListItemFilterOutput: + schema: + properties: + elasticcache_accounts: + items: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elasticcache_account_PerformClassMetadataOutput: {} + elasticcache_account_PerformPurgeSplitableOutput: {} + elasticcache_account_PerformResetPasswordOutput: {} + elasticcache_account_PerformSetClassMetadataOutput: {} + elasticcache_account_PerformSetUserMetadataOutput: {} + elasticcache_account_PerformStatusOutput: {} + elasticcache_account_ValidateCreateDataOutput: + schema: + properties: + elasticcache_account: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: object + elasticcache_account_ValidateUpdateDataOutput: + schema: + properties: + elasticcache_account: + $ref: '#/definitions/ElasticcacheAccountDetails' + type: object + elasticcache_acl_CustomizeDeleteOutput: + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/ElasticcacheAclDetails' + type: object + elasticcache_acl_FetchCustomizeColumnsOutput: + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/ElasticcacheAclDetails' + type: object + elasticcache_acl_GetDetailsClassMetadataOutput: + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_acl_GetDetailsMetadataOutput: + schema: + properties: + elasticcache_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_acl_GetDetailsStatusOutput: + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_acl_GetPropertyDistinctFieldOutput: {} + elasticcache_acl_GetPropertySplitableExportOutput: {} + elasticcache_acl_GetPropertySplitableOutput: {} + elasticcache_acl_GetPropertyTagValuePairsOutput: {} + elasticcache_acl_GetPropertyTagValueTreeOutput: {} + elasticcache_acl_ListItemFilterOutput: + schema: + properties: + elasticcache_acls: + items: + $ref: '#/definitions/ElasticcacheAclDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elasticcache_acl_PerformClassMetadataOutput: {} + elasticcache_acl_PerformPurgeSplitableOutput: {} + elasticcache_acl_PerformSetClassMetadataOutput: {} + elasticcache_acl_PerformSetUserMetadataOutput: {} + elasticcache_acl_PerformStatusOutput: {} + elasticcache_acl_ValidateCreateDataOutput: + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/ElasticcacheAclDetails' + type: object + elasticcache_acl_ValidateUpdateDataOutput: + schema: + properties: + elasticcache_acl: + $ref: '#/definitions/ElasticcacheAclDetails' + type: object + elasticcache_backup_CustomizeDeleteOutput: + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: object + elasticcache_backup_FetchCustomizeColumnsOutput: + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: object + elasticcache_backup_GetDetailsClassMetadataOutput: + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_backup_GetDetailsMetadataOutput: + schema: + properties: + elasticcache_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_backup_GetDetailsStatusOutput: + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_backup_GetPropertyDistinctFieldOutput: {} + elasticcache_backup_GetPropertySplitableExportOutput: {} + elasticcache_backup_GetPropertySplitableOutput: {} + elasticcache_backup_GetPropertyStatisticsOutput: + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/StatusStatistic' + type: object + elasticcache_backup_GetPropertyTagValuePairsOutput: {} + elasticcache_backup_GetPropertyTagValueTreeOutput: {} + elasticcache_backup_ListItemFilterOutput: + schema: + properties: + elasticcache_backups: + items: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elasticcache_backup_PerformClassMetadataOutput: {} + elasticcache_backup_PerformPurgeSplitableOutput: {} + elasticcache_backup_PerformRestoreInstanceOutput: {} + elasticcache_backup_PerformSetClassMetadataOutput: {} + elasticcache_backup_PerformSetUserMetadataOutput: {} + elasticcache_backup_PerformStatusOutput: {} + elasticcache_backup_ValidateCreateDataOutput: + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: object + elasticcache_backup_ValidateUpdateDataOutput: + schema: + properties: + elasticcache_backup: + $ref: '#/definitions/ElasticcacheBackupDetails' + type: object + elasticcache_parameter_CustomizeDeleteOutput: + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: object + elasticcache_parameter_FetchCustomizeColumnsOutput: + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: object + elasticcache_parameter_GetDetailsClassMetadataOutput: + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_parameter_GetDetailsMetadataOutput: + schema: + properties: + elasticcache_parameter: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_parameter_GetDetailsStatusOutput: + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_parameter_GetPropertyDistinctFieldOutput: {} + elasticcache_parameter_GetPropertySplitableExportOutput: {} + elasticcache_parameter_GetPropertySplitableOutput: {} + elasticcache_parameter_GetPropertyTagValuePairsOutput: {} + elasticcache_parameter_GetPropertyTagValueTreeOutput: {} + elasticcache_parameter_ListItemFilterOutput: + schema: + properties: + elasticcache_parameters: + items: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elasticcache_parameter_PerformClassMetadataOutput: {} + elasticcache_parameter_PerformPurgeSplitableOutput: {} + elasticcache_parameter_PerformSetClassMetadataOutput: {} + elasticcache_parameter_PerformSetUserMetadataOutput: {} + elasticcache_parameter_PerformStatusOutput: {} + elasticcache_parameter_ValidateCreateDataOutput: + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: object + elasticcache_parameter_ValidateUpdateDataOutput: + schema: + properties: + elasticcache_parameter: + $ref: '#/definitions/ElasticcacheParameterDetails' + type: object + elasticcache_sku_CustomizeDeleteOutput: + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: object + elasticcache_sku_FetchCustomizeColumnsOutput: + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: object + elasticcache_sku_GetDetailsClassMetadataOutput: + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_sku_GetDetailsMetadataOutput: + schema: + properties: + elasticcache_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticcache_sku_GetDetailsStatusOutput: + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticcache_sku_GetPropertyCapabilityOutput: {} + elasticcache_sku_GetPropertyDistinctFieldOutput: {} + elasticcache_sku_GetPropertyInstanceSpecsOutput: {} + elasticcache_sku_GetPropertySplitableExportOutput: {} + elasticcache_sku_GetPropertySplitableOutput: {} + elasticcache_sku_GetPropertyStatisticsOutput: + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/StatusStatistic' + type: object + elasticcache_sku_GetPropertySyncTasksOutput: {} + elasticcache_sku_GetPropertyTagValuePairsOutput: {} + elasticcache_sku_GetPropertyTagValueTreeOutput: {} + elasticcache_sku_ListItemFilterOutput: + schema: + properties: + elasticcache_skus: + items: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elasticcache_sku_PerformClassMetadataOutput: {} + elasticcache_sku_PerformPurgeSplitableOutput: {} + elasticcache_sku_PerformSetClassMetadataOutput: {} + elasticcache_sku_PerformSetUserMetadataOutput: {} + elasticcache_sku_PerformStatusOutput: {} + elasticcache_sku_PerformSyncSkusOutput: {} + elasticcache_sku_ValidateCreateDataOutput: + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: object + elasticcache_sku_ValidateUpdateDataOutput: + schema: + properties: + elasticcache_sku: + $ref: '#/definitions/ElasticcacheSkuDetails' + type: object + elasticcachesecgroup_CustomizeDeleteOutput: + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: object + elasticcachesecgroup_FetchCustomizeColumnsOutput: + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: object + elasticcachesecgroup_GetPropertyDistinctFieldOutput: {} + elasticcachesecgroup_GetPropertySplitableExportOutput: {} + elasticcachesecgroup_GetPropertySplitableOutput: {} + elasticcachesecgroup_ListItemFilterOutput: + schema: + properties: + elasticcachesecgroups: + items: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elasticcachesecgroup_PerformPurgeSplitableOutput: {} + elasticcachesecgroup_ValidateCreateDataOutput: + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: object + elasticcachesecgroup_ValidateUpdateDataOutput: + schema: + properties: + elasticcachesecgroup: + $ref: '#/definitions/ElasticcachesecgroupDetails' + type: object + elasticip_CustomizeDeleteOutput: + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipDetails' + type: object + elasticip_FetchCustomizeColumnsOutput: + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipDetails' + type: object + elasticip_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + elasticip: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + elasticip_GetDetailsClassMetadataOutput: + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticip_GetDetailsMetadataOutput: + schema: + properties: + elasticip: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + elasticip_GetDetailsStatusOutput: + schema: + properties: + elasticip: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + elasticip_GetPropertyDistinctFieldOutput: {} + elasticip_GetPropertyDomainStatisticsOutput: + schema: + properties: + elasticip: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elasticip_GetPropertyProjectStatisticsOutput: + schema: + properties: + elasticip: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + elasticip_GetPropertyProjectTagValuePairsOutput: {} + elasticip_GetPropertyProjectTagValueTreeOutput: {} + elasticip_GetPropertySplitableExportOutput: {} + elasticip_GetPropertySplitableOutput: {} + elasticip_GetPropertyStatisticsOutput: + schema: + properties: + elasticip: + $ref: '#/definitions/StatusStatistic' + type: object + elasticip_GetPropertyTagValuePairsOutput: {} + elasticip_GetPropertyTagValueTreeOutput: {} + elasticip_ListItemFilterOutput: + schema: + properties: + elasticips: + items: + $ref: '#/definitions/ElasticipDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + elasticip_PerformAssociateOutput: + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipAssociateInput' + type: object + elasticip_PerformCancelDeleteOutput: {} + elasticip_PerformChangeBandwidthOutput: {} + elasticip_PerformChangeOwnerOutput: {} + elasticip_PerformClassMetadataOutput: {} + elasticip_PerformDissociateOutput: {} + elasticip_PerformFreezeOutput: {} + elasticip_PerformPurgeOutput: {} + elasticip_PerformPurgeSplitableOutput: {} + elasticip_PerformSetClassMetadataOutput: {} + elasticip_PerformSetUserMetadataOutput: {} + elasticip_PerformStatusOutput: {} + elasticip_PerformSyncOutput: {} + elasticip_PerformSyncstatusOutput: {} + elasticip_PerformUnfreezeOutput: {} + elasticip_ValidateCreateDataOutput: + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipDetails' + type: object + elasticip_ValidateUpdateDataOutput: + schema: + properties: + elasticip: + $ref: '#/definitions/ElasticipDetails' + type: object + external_project_CustomizeDeleteOutput: + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectDetails' + type: object + external_project_FetchCustomizeColumnsOutput: + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectDetails' + type: object + external_project_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + external_project: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + external_project_GetDetailsClassMetadataOutput: + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + external_project_GetDetailsMetadataOutput: + schema: + properties: + external_project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + external_project_GetDetailsStatusOutput: + schema: + properties: + external_project: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + external_project_GetPropertyDistinctFieldOutput: {} + external_project_GetPropertyDomainStatisticsOutput: + schema: + properties: + external_project: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + external_project_GetPropertyProjectStatisticsOutput: + schema: + properties: + external_project: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + external_project_GetPropertyProjectTagValuePairsOutput: {} + external_project_GetPropertyProjectTagValueTreeOutput: {} + external_project_GetPropertySplitableExportOutput: {} + external_project_GetPropertySplitableOutput: {} + external_project_GetPropertyStatisticsOutput: + schema: + properties: + external_project: + $ref: '#/definitions/StatusStatistic' + type: object + external_project_GetPropertyTagValuePairsOutput: {} + external_project_GetPropertyTagValueTreeOutput: {} + external_project_ListItemFilterOutput: + schema: + properties: + external_projects: + items: + $ref: '#/definitions/ExternalProjectDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + external_project_PerformCancelDeleteOutput: {} + external_project_PerformChangeOwnerOutput: {} + external_project_PerformChangeProjectOutput: {} + external_project_PerformClassMetadataOutput: {} + external_project_PerformFreezeOutput: {} + external_project_PerformPurgeSplitableOutput: {} + external_project_PerformSetClassMetadataOutput: {} + external_project_PerformSetUserMetadataOutput: {} + external_project_PerformStatusOutput: {} + external_project_PerformUnfreezeOutput: {} + external_project_ValidateCreateDataOutput: + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectDetails' + type: object + external_project_ValidateUpdateDataOutput: + schema: + properties: + external_project: + $ref: '#/definitions/ExternalProjectDetails' + type: object + file_system_CustomizeDeleteOutput: + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemDetails' + type: object + file_system_FetchCustomizeColumnsOutput: + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemDetails' + type: object + file_system_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + file_system: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + file_system_GetDetailsClassMetadataOutput: + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + file_system_GetDetailsMetadataOutput: + schema: + properties: + file_system: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + file_system_GetDetailsStatusOutput: + schema: + properties: + file_system: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + file_system_GetPropertyDistinctFieldOutput: {} + file_system_GetPropertyDomainTagValuePairsOutput: {} + file_system_GetPropertyDomainTagValueTreeOutput: {} + file_system_GetPropertySplitableExportOutput: {} + file_system_GetPropertySplitableOutput: {} + file_system_GetPropertyStatisticsOutput: + schema: + properties: + file_system: + $ref: '#/definitions/StatusStatistic' + type: object + file_system_GetPropertyTagValuePairsOutput: {} + file_system_GetPropertyTagValueTreeOutput: {} + file_system_ListItemFilterOutput: + schema: + properties: + file_systems: + items: + $ref: '#/definitions/FileSystemDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + file_system_PerformChangeOwnerOutput: {} + file_system_PerformClassMetadataOutput: {} + file_system_PerformPrivateOutput: {} + file_system_PerformPublicOutput: {} + file_system_PerformPurgeSplitableOutput: {} + file_system_PerformRemoteUpdateOutput: {} + file_system_PerformSetClassMetadataOutput: {} + file_system_PerformSetUserMetadataOutput: {} + file_system_PerformStatusOutput: {} + file_system_PerformSyncstatusOutput: {} + file_system_ValidateCreateDataOutput: + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemDetails' + type: object + file_system_ValidateUpdateDataOutput: + schema: + properties: + file_system: + $ref: '#/definitions/FileSystemDetails' + type: object + global_vpc_CustomizeDeleteOutput: + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalVpcDetails' + type: object + global_vpc_FetchCustomizeColumnsOutput: + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalVpcDetails' + type: object + global_vpc_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + global_vpc: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + global_vpc_GetDetailsClassMetadataOutput: + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + global_vpc_GetDetailsMetadataOutput: + schema: + properties: + global_vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + global_vpc_GetDetailsStatusOutput: + schema: + properties: + global_vpc: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + global_vpc_GetPropertyDistinctFieldOutput: {} + global_vpc_GetPropertyDomainTagValuePairsOutput: {} + global_vpc_GetPropertyDomainTagValueTreeOutput: {} + global_vpc_GetPropertySplitableExportOutput: {} + global_vpc_GetPropertySplitableOutput: {} + global_vpc_GetPropertyStatisticsOutput: + schema: + properties: + global_vpc: + $ref: '#/definitions/StatusStatistic' + type: object + global_vpc_GetPropertyTagValuePairsOutput: {} + global_vpc_GetPropertyTagValueTreeOutput: {} + global_vpc_ListItemFilterOutput: + schema: + properties: + global_vpcs: + items: + $ref: '#/definitions/GlobalVpcDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + global_vpc_PerformChangeOwnerOutput: {} + global_vpc_PerformClassMetadataOutput: {} + global_vpc_PerformDisableOutput: {} + global_vpc_PerformEnableOutput: {} + global_vpc_PerformPrivateOutput: {} + global_vpc_PerformPublicOutput: {} + global_vpc_PerformPurgeSplitableOutput: {} + global_vpc_PerformSetClassMetadataOutput: {} + global_vpc_PerformSetUserMetadataOutput: {} + global_vpc_PerformStatusOutput: {} + global_vpc_PerformSyncstatusOutput: {} + global_vpc_ValidateCreateDataOutput: + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalVpcDetails' + type: object + global_vpc_ValidateUpdateDataOutput: + schema: + properties: + global_vpc: + $ref: '#/definitions/GlobalVpcDetails' + type: object + group_CustomizeDeleteOutput: + schema: + properties: + group: + $ref: '#/definitions/InstanceGroupDetail' + type: object + group_FetchCustomizeColumnsOutput: + schema: + properties: + group: + $ref: '#/definitions/InstanceGroupDetail' + type: object + group_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + group_GetDetailsClassMetadataOutput: + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetDetailsMetadataOutput: + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetDetailsStatusOutput: + schema: + properties: + group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + group_GetPropertyDistinctFieldOutput: {} + group_GetPropertyDomainStatisticsOutput: + schema: + properties: + group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + group_GetPropertyProjectStatisticsOutput: + schema: + properties: + group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + group_GetPropertyProjectTagValuePairsOutput: {} + group_GetPropertyProjectTagValueTreeOutput: {} + group_GetPropertySplitableExportOutput: {} + group_GetPropertySplitableOutput: {} + group_GetPropertyStatisticsOutput: + schema: + properties: + group: + $ref: '#/definitions/StatusStatistic' + type: object + group_GetPropertyTagValuePairsOutput: {} + group_GetPropertyTagValueTreeOutput: {} + group_ListItemFilterOutput: + schema: + properties: + groups: + items: + $ref: '#/definitions/InstanceGroupDetail' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + group_PerformAssociateEipOutput: {} + group_PerformAttachnetworkOutput: + schema: + properties: + group: + $ref: '#/definitions/SGroup' + type: object + group_PerformBindGuestsOutput: {} + group_PerformCancelDeleteOutput: {} + group_PerformChangeOwnerOutput: {} + group_PerformClassMetadataOutput: {} + group_PerformCreateEipOutput: {} + group_PerformDetachnetworkOutput: + schema: + properties: + group: + $ref: '#/definitions/SGroup' + type: object + group_PerformDisableOutput: {} + group_PerformDissociateEipOutput: {} + group_PerformEnableOutput: {} + group_PerformFreezeOutput: {} + group_PerformPurgeSplitableOutput: {} + group_PerformSetClassMetadataOutput: {} + group_PerformSetUserMetadataOutput: {} + group_PerformStatusOutput: {} + group_PerformUnbindGuestsOutput: {} + group_PerformUnfreezeOutput: {} + group_ValidateCreateDataOutput: + schema: + properties: + group: + $ref: '#/definitions/InstanceGroupDetail' + type: object + group_ValidateUpdateDataOutput: + schema: + properties: + group: + $ref: '#/definitions/InstanceGroupDetail' + type: object + groupguest_CustomizeDeleteOutput: + schema: + properties: + groupguest: + $ref: '#/definitions/GroupguestDetails' + type: object + groupguest_FetchCustomizeColumnsOutput: + schema: + properties: + groupguest: + $ref: '#/definitions/GroupguestDetails' + type: object + groupguest_GetPropertyDistinctFieldOutput: {} + groupguest_GetPropertySplitableExportOutput: {} + groupguest_GetPropertySplitableOutput: {} + groupguest_ListItemFilterOutput: + schema: + properties: + groupguests: + items: + $ref: '#/definitions/GroupguestDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + groupguest_PerformPurgeSplitableOutput: {} + groupguest_ValidateCreateDataOutput: + schema: + properties: + groupguest: + $ref: '#/definitions/GroupguestDetails' + type: object + groupguest_ValidateUpdateDataOutput: + schema: + properties: + groupguest: + $ref: '#/definitions/GroupguestDetails' + type: object + groupnetwork_CustomizeDeleteOutput: + schema: + properties: + groupnetwork: + $ref: '#/definitions/GroupnetworkDetails' + type: object + groupnetwork_FetchCustomizeColumnsOutput: + schema: + properties: + groupnetwork: + $ref: '#/definitions/GroupnetworkDetails' + type: object + groupnetwork_GetPropertyDistinctFieldOutput: {} + groupnetwork_GetPropertySplitableExportOutput: {} + groupnetwork_GetPropertySplitableOutput: {} + groupnetwork_ListItemFilterOutput: + schema: + properties: + groupnetworks: + items: + $ref: '#/definitions/GroupnetworkDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + groupnetwork_PerformPurgeSplitableOutput: {} + groupnetwork_ValidateCreateDataOutput: + schema: + properties: + groupnetwork: + $ref: '#/definitions/GroupnetworkDetails' + type: object + groupnetwork_ValidateUpdateDataOutput: + schema: + properties: + groupnetwork: + $ref: '#/definitions/GroupnetworkDetails' + type: object + guest_template_CustomizeDeleteOutput: + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateDetails' + type: object + guest_template_FetchCustomizeColumnsOutput: + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateDetails' + type: object + guest_template_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + guest_template: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + guest_template_GetDetailsClassMetadataOutput: + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_template_GetDetailsMetadataOutput: + schema: + properties: + guest_template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_template_GetDetailsStatusOutput: + schema: + properties: + guest_template: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + guest_template_GetPropertyDistinctFieldOutput: {} + guest_template_GetPropertyDomainStatisticsOutput: + schema: + properties: + guest_template: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + guest_template_GetPropertyProjectStatisticsOutput: + schema: + properties: + guest_template: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + guest_template_GetPropertyProjectTagValuePairsOutput: {} + guest_template_GetPropertyProjectTagValueTreeOutput: {} + guest_template_GetPropertySplitableExportOutput: {} + guest_template_GetPropertySplitableOutput: {} + guest_template_GetPropertyStatisticsOutput: + schema: + properties: + guest_template: + $ref: '#/definitions/StatusStatistic' + type: object + guest_template_GetPropertyTagValuePairsOutput: {} + guest_template_GetPropertyTagValueTreeOutput: {} + guest_template_ListItemFilterOutput: + schema: + properties: + guest_templates: + items: + $ref: '#/definitions/GuestTemplateDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + guest_template_PerformCancelDeleteOutput: {} + guest_template_PerformChangeOwnerOutput: {} + guest_template_PerformClassMetadataOutput: {} + guest_template_PerformFreezeOutput: {} + guest_template_PerformInspectOutput: {} + guest_template_PerformPrivateOutput: {} + guest_template_PerformPublicOutput: {} + guest_template_PerformPurgeSplitableOutput: {} + guest_template_PerformSetClassMetadataOutput: {} + guest_template_PerformSetUserMetadataOutput: {} + guest_template_PerformStatusOutput: {} + guest_template_PerformUnfreezeOutput: {} + guest_template_ValidateCreateDataOutput: + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateDetails' + type: object + guest_template_ValidateUpdateDataOutput: + schema: + properties: + guest_template: + $ref: '#/definitions/GuestTemplateDetails' + type: object + guestdisk_CustomizeDeleteOutput: + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestDiskDetails' + type: object + guestdisk_FetchCustomizeColumnsOutput: + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestDiskDetails' + type: object + guestdisk_GetPropertyDistinctFieldOutput: {} + guestdisk_GetPropertySplitableExportOutput: {} + guestdisk_GetPropertySplitableOutput: {} + guestdisk_ListItemFilterOutput: + schema: + properties: + guestdisks: + items: + $ref: '#/definitions/GuestDiskDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + guestdisk_PerformPurgeSplitableOutput: {} + guestdisk_ValidateCreateDataOutput: + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestDiskDetails' + type: object + guestdisk_ValidateUpdateDataOutput: + schema: + properties: + guestdisk: + $ref: '#/definitions/GuestDiskDetails' + type: object + guestnetwork_CustomizeDeleteOutput: + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + type: object + guestnetwork_FetchCustomizeColumnsOutput: + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + type: object + guestnetwork_GetPropertyDistinctFieldOutput: {} + guestnetwork_GetPropertySplitableExportOutput: {} + guestnetwork_GetPropertySplitableOutput: {} + guestnetwork_ListItemFilterOutput: + schema: + properties: + guestnetworks: + items: + $ref: '#/definitions/GuestnetworkDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + guestnetwork_PerformPurgeSplitableOutput: {} + guestnetwork_ValidateCreateDataOutput: + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + type: object + guestnetwork_ValidateUpdateDataOutput: + schema: + properties: + guestnetwork: + $ref: '#/definitions/GuestnetworkDetails' + type: object + guestsecgroup_CustomizeDeleteOutput: + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestsecgroupDetails' + type: object + guestsecgroup_FetchCustomizeColumnsOutput: + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestsecgroupDetails' + type: object + guestsecgroup_GetPropertyDistinctFieldOutput: {} + guestsecgroup_GetPropertySplitableExportOutput: {} + guestsecgroup_GetPropertySplitableOutput: {} + guestsecgroup_ListItemFilterOutput: + schema: + properties: + guestsecgroups: + items: + $ref: '#/definitions/GuestsecgroupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + guestsecgroup_PerformPurgeSplitableOutput: {} + guestsecgroup_ValidateCreateDataOutput: + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestsecgroupDetails' + type: object + guestsecgroup_ValidateUpdateDataOutput: + schema: + properties: + guestsecgroup: + $ref: '#/definitions/GuestsecgroupDetails' + type: object + host_CustomizeDeleteOutput: + schema: + properties: + host: + $ref: '#/definitions/HostDetails' + type: object + host_FetchCustomizeColumnsOutput: + schema: + properties: + host: + $ref: '#/definitions/HostDetails' + type: object + host_GetDetailsAppOptionsOutput: {} + host_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + host: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + host_GetDetailsClassMetadataOutput: + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + host_GetDetailsIpmiOutput: {} + host_GetDetailsJnlpOutput: {} + host_GetDetailsMetadataOutput: + schema: + properties: + host: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + host_GetDetailsSpecOutput: {} + host_GetDetailsStatusOutput: + schema: + properties: + host: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + host_GetDetailsTapConfigOutput: + schema: + properties: + host: + $ref: '#/definitions/SHostTapConfig' + type: object + host_GetDetailsVncOutput: {} + host_GetPropertyBmStartRegisterScriptOutput: {} + host_GetPropertyDistinctFieldOutput: {} + host_GetPropertyDomainTagValuePairsOutput: {} + host_GetPropertyDomainTagValueTreeOutput: {} + host_GetPropertyHostTypeCountOutput: {} + host_GetPropertyK8sMasterNodeIpsOutput: {} + host_GetPropertyNodeCountOutput: {} + host_GetPropertySplitableExportOutput: {} + host_GetPropertySplitableOutput: {} + host_GetPropertyStatisticsOutput: + schema: + properties: + host: + $ref: '#/definitions/StatusStatistic' + type: object + host_GetPropertyTagValuePairsOutput: {} + host_GetPropertyTagValueTreeOutput: {} + host_ListItemFilterOutput: + schema: + properties: + hosts: + items: + $ref: '#/definitions/HostDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + host_PerformAddNetifOutput: {} + host_PerformAutoMigrateOnHostDownOutput: {} + host_PerformCacheImageOutput: {} + host_PerformChangeOwnerOutput: {} + host_PerformClassMetadataOutput: {} + host_PerformConvertHypervisorOutput: {} + host_PerformDisableNetifOutput: {} + host_PerformDisableOutput: {} + host_PerformEjectIsoOutput: {} + host_PerformEnableNetifOutput: {} + host_PerformEnableOutput: {} + host_PerformHostExitMaintenanceOutput: {} + host_PerformHostMaintenanceOutput: {} + host_PerformInitializeOutput: {} + host_PerformInsertIsoOutput: {} + host_PerformIpmiProbeOutput: {} + host_PerformMaintenanceOutput: {} + host_PerformOfflineOutput: {} + host_PerformOnlineOutput: {} + host_PerformPingOutput: {} + host_PerformPrepareOutput: {} + host_PerformPrivateOutput: {} + host_PerformProbeIsolatedDevicesOutput: {} + host_PerformPublicOutput: {} + host_PerformPurgeSplitableOutput: {} + host_PerformRemoveAllNetifsOutput: {} + host_PerformRemoveNetifOutput: {} + host_PerformRenewPrepaidRecycleOutput: {} + host_PerformReserveCpusOutput: {} + host_PerformResetOutput: {} + host_PerformSetClassMetadataOutput: {} + host_PerformSetReservedResourceForIsolatedDeviceOutput: {} + host_PerformSetSchedtagOutput: {} + host_PerformSetUserMetadataOutput: {} + host_PerformStartOutput: {} + host_PerformStatusOutput: {} + host_PerformStopOutput: {} + host_PerformSyncConfigOutput: {} + host_PerformSyncstatusOutput: {} + host_PerformUndoConvertOutput: {} + host_PerformUndoPrepaidRecycleOutput: {} + host_PerformUnmaintenanceOutput: {} + host_PerformUnreserveCpusOutput: {} + host_PerformUpdateStorageOutput: {} + host_ValidateCreateDataOutput: + schema: + properties: + host: + $ref: '#/definitions/HostDetails' + type: object + host_ValidateUpdateDataOutput: + schema: + properties: + host: + $ref: '#/definitions/HostDetails' + type: object + hostnetwork_CustomizeDeleteOutput: + schema: + properties: + hostnetwork: + $ref: '#/definitions/HostnetworkDetails' + type: object + hostnetwork_FetchCustomizeColumnsOutput: + schema: + properties: + hostnetwork: + $ref: '#/definitions/HostnetworkDetails' + type: object + hostnetwork_GetPropertyDistinctFieldOutput: {} + hostnetwork_GetPropertySplitableExportOutput: {} + hostnetwork_GetPropertySplitableOutput: {} + hostnetwork_ListItemFilterOutput: + schema: + properties: + hostnetworks: + items: + $ref: '#/definitions/HostnetworkDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + hostnetwork_PerformPurgeSplitableOutput: {} + hostnetwork_ValidateCreateDataOutput: + schema: + properties: + hostnetwork: + $ref: '#/definitions/HostnetworkDetails' + type: object + hostnetwork_ValidateUpdateDataOutput: + schema: + properties: + hostnetwork: + $ref: '#/definitions/HostnetworkDetails' + type: object + hoststorage_CustomizeDeleteOutput: + schema: + properties: + hoststorage: + $ref: '#/definitions/HoststorageDetails' + type: object + hoststorage_FetchCustomizeColumnsOutput: + schema: + properties: + hoststorage: + $ref: '#/definitions/HoststorageDetails' + type: object + hoststorage_GetPropertyDistinctFieldOutput: {} + hoststorage_GetPropertySplitableExportOutput: {} + hoststorage_GetPropertySplitableOutput: {} + hoststorage_ListItemFilterOutput: + schema: + properties: + hoststorages: + items: + $ref: '#/definitions/HoststorageDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + hoststorage_PerformPurgeSplitableOutput: {} + hoststorage_ValidateCreateDataOutput: + schema: + properties: + hoststorage: + $ref: '#/definitions/HoststorageDetails' + type: object + hoststorage_ValidateUpdateDataOutput: + schema: + properties: + hoststorage: + $ref: '#/definitions/HoststorageDetails' + type: object + hostwire_CustomizeDeleteOutput: + schema: + properties: + hostwire: + $ref: '#/definitions/HostwireDetails' + type: object + hostwire_FetchCustomizeColumnsOutput: + schema: + properties: + hostwire: + $ref: '#/definitions/HostwireDetails' + type: object + hostwire_GetPropertyDistinctFieldOutput: {} + hostwire_GetPropertySplitableExportOutput: {} + hostwire_GetPropertySplitableOutput: {} + hostwire_ListItemFilterOutput: + schema: + properties: + hostwires: + items: + $ref: '#/definitions/HostwireDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + hostwire_PerformPurgeSplitableOutput: {} + hostwire_ValidateCreateDataOutput: + schema: + properties: + hostwire: + $ref: '#/definitions/HostwireDetails' + type: object + hostwire_ValidateUpdateDataOutput: + schema: + properties: + hostwire: + $ref: '#/definitions/HostwireDetails' + type: object + instance_backup_CustomizeDeleteOutput: + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupDetails' + type: object + instance_backup_FetchCustomizeColumnsOutput: + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupDetails' + type: object + instance_backup_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + instance_backup: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + instance_backup_GetDetailsClassMetadataOutput: + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_backup_GetDetailsMetadataOutput: + schema: + properties: + instance_backup: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_backup_GetDetailsStatusOutput: + schema: + properties: + instance_backup: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + instance_backup_GetPropertyDistinctFieldOutput: {} + instance_backup_GetPropertyDomainStatisticsOutput: + schema: + properties: + instance_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + instance_backup_GetPropertyProjectStatisticsOutput: + schema: + properties: + instance_backup: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + instance_backup_GetPropertyProjectTagValuePairsOutput: {} + instance_backup_GetPropertyProjectTagValueTreeOutput: {} + instance_backup_GetPropertySplitableExportOutput: {} + instance_backup_GetPropertySplitableOutput: {} + instance_backup_GetPropertyStatisticsOutput: + schema: + properties: + instance_backup: + $ref: '#/definitions/StatusStatistic' + type: object + instance_backup_GetPropertyTagValuePairsOutput: {} + instance_backup_GetPropertyTagValueTreeOutput: {} + instance_backup_ListItemFilterOutput: + schema: + properties: + instance_backups: + items: + $ref: '#/definitions/InstanceBackupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + instance_backup_PerformCancelDeleteOutput: {} + instance_backup_PerformChangeOwnerOutput: {} + instance_backup_PerformClassMetadataOutput: {} + instance_backup_PerformFreezeOutput: {} + instance_backup_PerformPackOutput: {} + instance_backup_PerformPurgeSplitableOutput: {} + instance_backup_PerformRecoveryOutput: {} + instance_backup_PerformSetClassMetadataOutput: {} + instance_backup_PerformSetUserMetadataOutput: {} + instance_backup_PerformStatusOutput: {} + instance_backup_PerformSyncstatusOutput: {} + instance_backup_PerformUnfreezeOutput: {} + instance_backup_ValidateCreateDataOutput: + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupDetails' + type: object + instance_backup_ValidateUpdateDataOutput: + schema: + properties: + instance_backup: + $ref: '#/definitions/InstanceBackupDetails' + type: object + instance_snapshot_CustomizeDeleteOutput: + schema: + properties: + instance_snapshot: + $ref: '#/definitions/InstanceSnapshotDetails' + type: object + instance_snapshot_FetchCustomizeColumnsOutput: + schema: + properties: + instance_snapshot: + $ref: '#/definitions/InstanceSnapshotDetails' + type: object + instance_snapshot_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + instance_snapshot: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + instance_snapshot_GetDetailsClassMetadataOutput: + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_snapshot_GetDetailsMetadataOutput: + schema: + properties: + instance_snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + instance_snapshot_GetDetailsStatusOutput: + schema: + properties: + instance_snapshot: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + instance_snapshot_GetPropertyDistinctFieldOutput: {} + instance_snapshot_GetPropertyDomainStatisticsOutput: + schema: + properties: + instance_snapshot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + instance_snapshot_GetPropertyProjectStatisticsOutput: + schema: + properties: + instance_snapshot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + instance_snapshot_GetPropertyProjectTagValuePairsOutput: {} + instance_snapshot_GetPropertyProjectTagValueTreeOutput: {} + instance_snapshot_GetPropertySplitableExportOutput: {} + instance_snapshot_GetPropertySplitableOutput: {} + instance_snapshot_GetPropertyStatisticsOutput: + schema: + properties: + instance_snapshot: + $ref: '#/definitions/StatusStatistic' + type: object + instance_snapshot_GetPropertyTagValuePairsOutput: {} + instance_snapshot_GetPropertyTagValueTreeOutput: {} + instance_snapshot_ListItemFilterOutput: + schema: + properties: + instance_snapshots: + items: + $ref: '#/definitions/InstanceSnapshotDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + instance_snapshot_PerformCancelDeleteOutput: {} + instance_snapshot_PerformChangeOwnerOutput: {} + instance_snapshot_PerformClassMetadataOutput: {} + instance_snapshot_PerformFreezeOutput: {} + instance_snapshot_PerformPurgeSplitableOutput: {} + instance_snapshot_PerformSetClassMetadataOutput: {} + instance_snapshot_PerformSetUserMetadataOutput: {} + instance_snapshot_PerformStatusOutput: {} + instance_snapshot_PerformUnfreezeOutput: {} + instance_snapshot_ValidateCreateDataOutput: + schema: + properties: + instance_snapshot: + $ref: '#/definitions/InstanceSnapshotDetails' + type: object + instance_snapshot_ValidateUpdateDataOutput: + schema: + properties: + instance_snapshot: + $ref: '#/definitions/InstanceSnapshotDetails' + type: object + inter_vpc_network_CustomizeDeleteOutput: + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkDetails' + type: object + inter_vpc_network_FetchCustomizeColumnsOutput: + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkDetails' + type: object + inter_vpc_network_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + inter_vpc_network_GetDetailsClassMetadataOutput: + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_GetDetailsMetadataOutput: + schema: + properties: + inter_vpc_network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_GetDetailsStatusOutput: + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + inter_vpc_network_GetPropertyDistinctFieldOutput: {} + inter_vpc_network_GetPropertyDomainTagValuePairsOutput: {} + inter_vpc_network_GetPropertyDomainTagValueTreeOutput: {} + inter_vpc_network_GetPropertySplitableExportOutput: {} + inter_vpc_network_GetPropertySplitableOutput: {} + inter_vpc_network_GetPropertyStatisticsOutput: + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/StatusStatistic' + type: object + inter_vpc_network_GetPropertyTagValuePairsOutput: {} + inter_vpc_network_GetPropertyTagValueTreeOutput: {} + inter_vpc_network_ListItemFilterOutput: + schema: + properties: + inter_vpc_networks: + items: + $ref: '#/definitions/InterVpcNetworkDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + inter_vpc_network_PerformAddvpcOutput: {} + inter_vpc_network_PerformChangeOwnerOutput: {} + inter_vpc_network_PerformClassMetadataOutput: {} + inter_vpc_network_PerformDisableOutput: {} + inter_vpc_network_PerformEnableOutput: {} + inter_vpc_network_PerformPrivateOutput: {} + inter_vpc_network_PerformPublicOutput: {} + inter_vpc_network_PerformPurgeSplitableOutput: {} + inter_vpc_network_PerformRemovevpcOutput: {} + inter_vpc_network_PerformSetClassMetadataOutput: {} + inter_vpc_network_PerformSetUserMetadataOutput: {} + inter_vpc_network_PerformStatusOutput: {} + inter_vpc_network_PerformSyncstatusOutput: {} + inter_vpc_network_ValidateCreateDataOutput: + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkDetails' + type: object + inter_vpc_network_ValidateUpdateDataOutput: + schema: + properties: + inter_vpc_network: + $ref: '#/definitions/InterVpcNetworkDetails' + type: object + inter_vpc_network_route_set_CustomizeDeleteOutput: + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: object + inter_vpc_network_route_set_FetchCustomizeColumnsOutput: + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: object + inter_vpc_network_route_set_GetDetailsClassMetadataOutput: + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_route_set_GetDetailsMetadataOutput: + schema: + properties: + inter_vpc_network_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + inter_vpc_network_route_set_GetDetailsStatusOutput: + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + inter_vpc_network_route_set_GetPropertyDistinctFieldOutput: {} + inter_vpc_network_route_set_GetPropertySplitableExportOutput: {} + inter_vpc_network_route_set_GetPropertySplitableOutput: {} + inter_vpc_network_route_set_GetPropertyStatisticsOutput: + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/StatusStatistic' + type: object + inter_vpc_network_route_set_GetPropertyTagValuePairsOutput: {} + inter_vpc_network_route_set_GetPropertyTagValueTreeOutput: {} + inter_vpc_network_route_set_ListItemFilterOutput: + schema: + properties: + inter_vpc_network_route_sets: + items: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + inter_vpc_network_route_set_PerformClassMetadataOutput: {} + inter_vpc_network_route_set_PerformDisableOutput: {} + inter_vpc_network_route_set_PerformEnableOutput: {} + inter_vpc_network_route_set_PerformPurgeSplitableOutput: {} + inter_vpc_network_route_set_PerformSetClassMetadataOutput: {} + inter_vpc_network_route_set_PerformSetUserMetadataOutput: {} + inter_vpc_network_route_set_PerformStatusOutput: {} + inter_vpc_network_route_set_ValidateCreateDataOutput: + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: object + inter_vpc_network_route_set_ValidateUpdateDataOutput: + schema: + properties: + inter_vpc_network_route_set: + $ref: '#/definitions/InterVpcNetworkRouteSetDetails' + type: object + inter_vpc_network_vpc_CustomizeDeleteOutput: + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + inter_vpc_network_vpc_FetchCustomizeColumnsOutput: + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + inter_vpc_network_vpc_GetPropertyDistinctFieldOutput: {} + inter_vpc_network_vpc_GetPropertySplitableExportOutput: {} + inter_vpc_network_vpc_GetPropertySplitableOutput: {} + inter_vpc_network_vpc_ListItemFilterOutput: + schema: + properties: + inter_vpc_network_vpcs: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + inter_vpc_network_vpc_PerformPurgeSplitableOutput: {} + inter_vpc_network_vpc_ValidateCreateDataOutput: + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + inter_vpc_network_vpc_ValidateUpdateDataOutput: + schema: + properties: + inter_vpc_network_vpc: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + ipv6_gateway_CustomizeDeleteOutput: + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayDetails' + type: object + ipv6_gateway_FetchCustomizeColumnsOutput: + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayDetails' + type: object + ipv6_gateway_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + ipv6_gateway_GetDetailsClassMetadataOutput: + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + ipv6_gateway_GetDetailsMetadataOutput: + schema: + properties: + ipv6_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + ipv6_gateway_GetDetailsStatusOutput: + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + ipv6_gateway_GetPropertyDistinctFieldOutput: {} + ipv6_gateway_GetPropertyDomainStatisticsOutput: + schema: + properties: + ipv6_gateway: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + ipv6_gateway_GetPropertyProjectStatisticsOutput: + schema: + properties: + ipv6_gateway: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + ipv6_gateway_GetPropertyProjectTagValuePairsOutput: {} + ipv6_gateway_GetPropertyProjectTagValueTreeOutput: {} + ipv6_gateway_GetPropertySplitableExportOutput: {} + ipv6_gateway_GetPropertySplitableOutput: {} + ipv6_gateway_GetPropertyStatisticsOutput: + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/StatusStatistic' + type: object + ipv6_gateway_GetPropertyTagValuePairsOutput: {} + ipv6_gateway_GetPropertyTagValueTreeOutput: {} + ipv6_gateway_ListItemFilterOutput: + schema: + properties: + ipv6_gateways: + items: + $ref: '#/definitions/IPv6GatewayDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + ipv6_gateway_PerformCancelDeleteOutput: {} + ipv6_gateway_PerformChangeOwnerOutput: {} + ipv6_gateway_PerformClassMetadataOutput: {} + ipv6_gateway_PerformFreezeOutput: {} + ipv6_gateway_PerformPrivateOutput: {} + ipv6_gateway_PerformPublicOutput: {} + ipv6_gateway_PerformPurgeSplitableOutput: {} + ipv6_gateway_PerformSetClassMetadataOutput: {} + ipv6_gateway_PerformSetUserMetadataOutput: {} + ipv6_gateway_PerformStatusOutput: {} + ipv6_gateway_PerformUnfreezeOutput: {} + ipv6_gateway_ValidateCreateDataOutput: + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayDetails' + type: object + ipv6_gateway_ValidateUpdateDataOutput: + schema: + properties: + ipv6_gateway: + $ref: '#/definitions/IPv6GatewayDetails' + type: object + isolated_device_CustomizeDeleteOutput: + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolateDeviceDetails' + type: object + isolated_device_FetchCustomizeColumnsOutput: + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolateDeviceDetails' + type: object + isolated_device_GetDetailsClassMetadataOutput: + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_GetDetailsMetadataOutput: + schema: + properties: + isolated_device: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_GetPropertyDistinctFieldOutput: {} + isolated_device_GetPropertySplitableExportOutput: {} + isolated_device_GetPropertySplitableOutput: {} + isolated_device_GetPropertyTagValuePairsOutput: {} + isolated_device_GetPropertyTagValueTreeOutput: {} + isolated_device_ListItemFilterOutput: + schema: + properties: + isolated_devices: + items: + $ref: '#/definitions/IsolateDeviceDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + isolated_device_PerformClassMetadataOutput: {} + isolated_device_PerformPurgeOutput: {} + isolated_device_PerformPurgeSplitableOutput: {} + isolated_device_PerformSetClassMetadataOutput: {} + isolated_device_PerformSetUserMetadataOutput: {} + isolated_device_ValidateCreateDataOutput: + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolateDeviceDetails' + type: object + isolated_device_ValidateUpdateDataOutput: + schema: + properties: + isolated_device: + $ref: '#/definitions/IsolateDeviceDetails' + type: object + isolated_device_model_CustomizeDeleteOutput: + schema: + properties: + isolated_device_model: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + isolated_device_model_FetchCustomizeColumnsOutput: + schema: + properties: + isolated_device_model: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + isolated_device_model_GetDetailsClassMetadataOutput: + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_model_GetDetailsMetadataOutput: + schema: + properties: + isolated_device_model: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + isolated_device_model_GetPropertyDistinctFieldOutput: {} + isolated_device_model_GetPropertySplitableExportOutput: {} + isolated_device_model_GetPropertySplitableOutput: {} + isolated_device_model_GetPropertyTagValuePairsOutput: {} + isolated_device_model_GetPropertyTagValueTreeOutput: {} + isolated_device_model_ListItemFilterOutput: + schema: + properties: + isolated_device_models: + items: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + isolated_device_model_PerformClassMetadataOutput: {} + isolated_device_model_PerformPurgeSplitableOutput: {} + isolated_device_model_PerformSetClassMetadataOutput: {} + isolated_device_model_PerformSetUserMetadataOutput: {} + isolated_device_model_ValidateCreateDataOutput: + schema: + properties: + isolated_device_model: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + isolated_device_model_ValidateUpdateDataOutput: + schema: + properties: + isolated_device_model: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + kafka_CustomizeDeleteOutput: + schema: + properties: + kafka: + $ref: '#/definitions/KafkaDetails' + type: object + kafka_FetchCustomizeColumnsOutput: + schema: + properties: + kafka: + $ref: '#/definitions/KafkaDetails' + type: object + kafka_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + kafka: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + kafka_GetDetailsClassMetadataOutput: + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kafka_GetDetailsMetadataOutput: + schema: + properties: + kafka: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kafka_GetDetailsStatusOutput: + schema: + properties: + kafka: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + kafka_GetDetailsTopicsOutput: + schema: + properties: + kafka: + items: + $ref: '#/definitions/SKafkaTopic' + type: array + x-go-name: Output + type: object + kafka_GetPropertyDistinctFieldOutput: {} + kafka_GetPropertyDomainStatisticsOutput: + schema: + properties: + kafka: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + kafka_GetPropertyProjectStatisticsOutput: + schema: + properties: + kafka: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + kafka_GetPropertyProjectTagValuePairsOutput: {} + kafka_GetPropertyProjectTagValueTreeOutput: {} + kafka_GetPropertySplitableExportOutput: {} + kafka_GetPropertySplitableOutput: {} + kafka_GetPropertyStatisticsOutput: + schema: + properties: + kafka: + $ref: '#/definitions/StatusStatistic' + type: object + kafka_GetPropertyTagValuePairsOutput: {} + kafka_GetPropertyTagValueTreeOutput: {} + kafka_ListItemFilterOutput: + schema: + properties: + kafkas: + items: + $ref: '#/definitions/KafkaDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + kafka_PerformCancelDeleteOutput: {} + kafka_PerformChangeOwnerOutput: {} + kafka_PerformClassMetadataOutput: {} + kafka_PerformFreezeOutput: {} + kafka_PerformPurgeSplitableOutput: {} + kafka_PerformSetClassMetadataOutput: {} + kafka_PerformSetUserMetadataOutput: {} + kafka_PerformStatusOutput: {} + kafka_PerformSyncstatusOutput: {} + kafka_PerformUnfreezeOutput: {} + kafka_ValidateCreateDataOutput: + schema: + properties: + kafka: + $ref: '#/definitions/KafkaDetails' + type: object + kafka_ValidateUpdateDataOutput: + schema: + properties: + kafka: + $ref: '#/definitions/KafkaDetails' + type: object + keypair_CustomizeDeleteOutput: + schema: + properties: + keypair: + $ref: '#/definitions/KeypairDetails' + type: object + keypair_FetchCustomizeColumnsOutput: + schema: + properties: + keypair: + $ref: '#/definitions/KeypairDetails' + type: object + keypair_GetDetailsClassMetadataOutput: + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + keypair_GetDetailsMetadataOutput: + schema: + properties: + keypair: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + keypair_GetDetailsPrivatekeyOutput: {} + keypair_GetPropertyDistinctFieldOutput: {} + keypair_GetPropertySplitableExportOutput: {} + keypair_GetPropertySplitableOutput: {} + keypair_GetPropertyTagValuePairsOutput: {} + keypair_GetPropertyTagValueTreeOutput: {} + keypair_ListItemFilterOutput: + schema: + properties: + keypairs: + items: + $ref: '#/definitions/KeypairDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + keypair_PerformClassMetadataOutput: {} + keypair_PerformPurgeSplitableOutput: {} + keypair_PerformSetClassMetadataOutput: {} + keypair_PerformSetUserMetadataOutput: {} + keypair_ValidateCreateDataOutput: + schema: + properties: + keypair: + $ref: '#/definitions/KeypairDetails' + type: object + keypair_ValidateUpdateDataOutput: + schema: + properties: + keypair: + $ref: '#/definitions/KeypairDetails' + type: object + kube_cluster_CustomizeDeleteOutput: + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDetails' + type: object + kube_cluster_FetchCustomizeColumnsOutput: + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDetails' + type: object + kube_cluster_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + kube_cluster: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + kube_cluster_GetDetailsClassMetadataOutput: + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_cluster_GetDetailsKubeconfigOutput: + schema: + properties: + kube_cluster: + $ref: '#/definitions/SKubeconfig' + type: object + kube_cluster_GetDetailsMetadataOutput: + schema: + properties: + kube_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_cluster_GetDetailsStatusOutput: + schema: + properties: + kube_cluster: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + kube_cluster_GetPropertyDistinctFieldOutput: {} + kube_cluster_GetPropertyDomainTagValuePairsOutput: {} + kube_cluster_GetPropertyDomainTagValueTreeOutput: {} + kube_cluster_GetPropertySplitableExportOutput: {} + kube_cluster_GetPropertySplitableOutput: {} + kube_cluster_GetPropertyStatisticsOutput: + schema: + properties: + kube_cluster: + $ref: '#/definitions/StatusStatistic' + type: object + kube_cluster_GetPropertyTagValuePairsOutput: {} + kube_cluster_GetPropertyTagValueTreeOutput: {} + kube_cluster_ListItemFilterOutput: + schema: + properties: + kube_clusters: + items: + $ref: '#/definitions/KubeClusterDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + kube_cluster_PerformChangeOwnerOutput: {} + kube_cluster_PerformClassMetadataOutput: {} + kube_cluster_PerformDisableOutput: {} + kube_cluster_PerformEnableOutput: {} + kube_cluster_PerformPrivateOutput: {} + kube_cluster_PerformPublicOutput: {} + kube_cluster_PerformPurgeSplitableOutput: {} + kube_cluster_PerformSetClassMetadataOutput: {} + kube_cluster_PerformSetUserMetadataOutput: {} + kube_cluster_PerformStatusOutput: {} + kube_cluster_PerformSyncstatusOutput: {} + kube_cluster_ValidateCreateDataOutput: + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDetails' + type: object + kube_cluster_ValidateUpdateDataOutput: + schema: + properties: + kube_cluster: + $ref: '#/definitions/KubeClusterDetails' + type: object + kube_node_CustomizeDeleteOutput: + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeDetails' + type: object + kube_node_FetchCustomizeColumnsOutput: + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeDetails' + type: object + kube_node_GetDetailsClassMetadataOutput: + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_GetDetailsMetadataOutput: + schema: + properties: + kube_node: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_GetDetailsStatusOutput: + schema: + properties: + kube_node: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + kube_node_GetPropertyDistinctFieldOutput: {} + kube_node_GetPropertySplitableExportOutput: {} + kube_node_GetPropertySplitableOutput: {} + kube_node_GetPropertyStatisticsOutput: + schema: + properties: + kube_node: + $ref: '#/definitions/StatusStatistic' + type: object + kube_node_GetPropertyTagValuePairsOutput: {} + kube_node_GetPropertyTagValueTreeOutput: {} + kube_node_ListItemFilterOutput: + schema: + properties: + kube_nodes: + items: + $ref: '#/definitions/KubeNodeDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + kube_node_PerformClassMetadataOutput: {} + kube_node_PerformPurgeSplitableOutput: {} + kube_node_PerformSetClassMetadataOutput: {} + kube_node_PerformSetUserMetadataOutput: {} + kube_node_PerformStatusOutput: {} + kube_node_ValidateCreateDataOutput: + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeDetails' + type: object + kube_node_ValidateUpdateDataOutput: + schema: + properties: + kube_node: + $ref: '#/definitions/KubeNodeDetails' + type: object + kube_node_pool_CustomizeDeleteOutput: + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolDetails' + type: object + kube_node_pool_FetchCustomizeColumnsOutput: + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolDetails' + type: object + kube_node_pool_GetDetailsClassMetadataOutput: + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_pool_GetDetailsMetadataOutput: + schema: + properties: + kube_node_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + kube_node_pool_GetDetailsStatusOutput: + schema: + properties: + kube_node_pool: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + kube_node_pool_GetPropertyDistinctFieldOutput: {} + kube_node_pool_GetPropertySplitableExportOutput: {} + kube_node_pool_GetPropertySplitableOutput: {} + kube_node_pool_GetPropertyStatisticsOutput: + schema: + properties: + kube_node_pool: + $ref: '#/definitions/StatusStatistic' + type: object + kube_node_pool_GetPropertyTagValuePairsOutput: {} + kube_node_pool_GetPropertyTagValueTreeOutput: {} + kube_node_pool_ListItemFilterOutput: + schema: + properties: + kube_node_pools: + items: + $ref: '#/definitions/KubeNodePoolDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + kube_node_pool_PerformClassMetadataOutput: {} + kube_node_pool_PerformPurgeSplitableOutput: {} + kube_node_pool_PerformSetClassMetadataOutput: {} + kube_node_pool_PerformSetUserMetadataOutput: {} + kube_node_pool_PerformStatusOutput: {} + kube_node_pool_PerformSyncstatusOutput: {} + kube_node_pool_ValidateCreateDataOutput: + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolDetails' + type: object + kube_node_pool_ValidateUpdateDataOutput: + schema: + properties: + kube_node_pool: + $ref: '#/definitions/KubeNodePoolDetails' + type: object + loadbalancer_CustomizeDeleteOutput: + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDetails' + type: object + loadbalancer_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDetails' + type: object + loadbalancer_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + loadbalancer: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + loadbalancer_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_GetDetailsStatusOutput: + schema: + properties: + loadbalancer: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_GetPropertyDistinctFieldOutput: {} + loadbalancer_GetPropertyDomainStatisticsOutput: + schema: + properties: + loadbalancer: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_GetPropertyProjectStatisticsOutput: + schema: + properties: + loadbalancer: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_GetPropertyProjectTagValuePairsOutput: {} + loadbalancer_GetPropertyProjectTagValueTreeOutput: {} + loadbalancer_GetPropertySplitableExportOutput: {} + loadbalancer_GetPropertySplitableOutput: {} + loadbalancer_GetPropertyStatisticsOutput: + schema: + properties: + loadbalancer: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_GetPropertyTagValuePairsOutput: {} + loadbalancer_GetPropertyTagValueTreeOutput: {} + loadbalancer_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancers: + items: + $ref: '#/definitions/LoadbalancerDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_PerformAssociateEipOutput: {} + loadbalancer_PerformCancelDeleteOutput: {} + loadbalancer_PerformChangeOwnerOutput: {} + loadbalancer_PerformClassMetadataOutput: {} + loadbalancer_PerformCreateEipOutput: {} + loadbalancer_PerformDissociateEipOutput: {} + loadbalancer_PerformFreezeOutput: {} + loadbalancer_PerformPurgeOutput: {} + loadbalancer_PerformPurgeSplitableOutput: {} + loadbalancer_PerformRemoteUpdateOutput: {} + loadbalancer_PerformSetClassMetadataOutput: {} + loadbalancer_PerformSetUserMetadataOutput: {} + loadbalancer_PerformStatusOutput: {} + loadbalancer_PerformSyncstatusOutput: {} + loadbalancer_PerformUnfreezeOutput: {} + loadbalancer_ValidateCreateDataOutput: + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDetails' + type: object + loadbalancer_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer: + $ref: '#/definitions/LoadbalancerDetails' + type: object + loadbalancer_acl_CustomizeDeleteOutput: + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclDetails' + type: object + loadbalancer_acl_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclDetails' + type: object + loadbalancer_acl_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + loadbalancer_acl_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_acl_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer_acl: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_acl_GetDetailsStatusOutput: + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_acl_GetPropertyDistinctFieldOutput: {} + loadbalancer_acl_GetPropertyDomainStatisticsOutput: + schema: + properties: + loadbalancer_acl: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_acl_GetPropertyProjectStatisticsOutput: + schema: + properties: + loadbalancer_acl: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_acl_GetPropertyProjectTagValuePairsOutput: {} + loadbalancer_acl_GetPropertyProjectTagValueTreeOutput: {} + loadbalancer_acl_GetPropertySplitableExportOutput: {} + loadbalancer_acl_GetPropertySplitableOutput: {} + loadbalancer_acl_GetPropertyStatisticsOutput: + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_acl_GetPropertyTagValuePairsOutput: {} + loadbalancer_acl_GetPropertyTagValueTreeOutput: {} + loadbalancer_acl_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_acls: + items: + $ref: '#/definitions/LoadbalancerAclDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_acl_PerformCancelDeleteOutput: {} + loadbalancer_acl_PerformChangeOwnerOutput: {} + loadbalancer_acl_PerformClassMetadataOutput: {} + loadbalancer_acl_PerformFreezeOutput: {} + loadbalancer_acl_PerformPatchOutput: {} + loadbalancer_acl_PerformPrivateOutput: {} + loadbalancer_acl_PerformPublicOutput: {} + loadbalancer_acl_PerformPurgeOutput: {} + loadbalancer_acl_PerformPurgeSplitableOutput: {} + loadbalancer_acl_PerformSetClassMetadataOutput: {} + loadbalancer_acl_PerformSetUserMetadataOutput: {} + loadbalancer_acl_PerformStatusOutput: {} + loadbalancer_acl_PerformUnfreezeOutput: {} + loadbalancer_acl_ValidateCreateDataOutput: + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclDetails' + type: object + loadbalancer_acl_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer_acl: + $ref: '#/definitions/LoadbalancerAclDetails' + type: object + loadbalancer_agent_CustomizeDeleteOutput: + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: object + loadbalancer_agent_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: object + loadbalancer_agent_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_agent_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer_agent: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_agent_GetPropertyDefaultParamsOutput: {} + loadbalancer_agent_GetPropertyDistinctFieldOutput: {} + loadbalancer_agent_GetPropertySplitableExportOutput: {} + loadbalancer_agent_GetPropertySplitableOutput: {} + loadbalancer_agent_GetPropertyTagValuePairsOutput: {} + loadbalancer_agent_GetPropertyTagValueTreeOutput: {} + loadbalancer_agent_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_agents: + items: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_agent_PerformClassMetadataOutput: {} + loadbalancer_agent_PerformDeployOutput: + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDeployInput' + type: object + loadbalancer_agent_PerformHbOutput: {} + loadbalancer_agent_PerformJoinClusterOutput: {} + loadbalancer_agent_PerformLeaveClusterOutput: {} + loadbalancer_agent_PerformParamsPatchOutput: {} + loadbalancer_agent_PerformPurgeSplitableOutput: {} + loadbalancer_agent_PerformSetClassMetadataOutput: {} + loadbalancer_agent_PerformSetUserMetadataOutput: {} + loadbalancer_agent_PerformUndeployOutput: {} + loadbalancer_agent_ValidateCreateDataOutput: + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: object + loadbalancer_agent_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer_agent: + $ref: '#/definitions/LoadbalancerAgentDetails' + type: object + loadbalancer_backend_CustomizeDeleteOutput: + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: object + loadbalancer_backend_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: object + loadbalancer_backend_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer_backend: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_GetDetailsStatusOutput: + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_backend_GetPropertyDistinctFieldOutput: {} + loadbalancer_backend_GetPropertySplitableExportOutput: {} + loadbalancer_backend_GetPropertySplitableOutput: {} + loadbalancer_backend_GetPropertyStatisticsOutput: + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_backend_GetPropertyTagValuePairsOutput: {} + loadbalancer_backend_GetPropertyTagValueTreeOutput: {} + loadbalancer_backend_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_backends: + items: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_backend_PerformClassMetadataOutput: {} + loadbalancer_backend_PerformPurgeOutput: {} + loadbalancer_backend_PerformPurgeSplitableOutput: {} + loadbalancer_backend_PerformSetClassMetadataOutput: {} + loadbalancer_backend_PerformSetUserMetadataOutput: {} + loadbalancer_backend_PerformStatusOutput: {} + loadbalancer_backend_ValidateCreateDataOutput: + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: object + loadbalancer_backend_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer_backend: + $ref: '#/definitions/LoadbalancerBackendDetails' + type: object + loadbalancer_backend_group_CustomizeDeleteOutput: + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: object + loadbalancer_backend_group_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: object + loadbalancer_backend_group_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_group_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer_backend_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_backend_group_GetDetailsStatusOutput: + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_backend_group_GetPropertyDistinctFieldOutput: {} + loadbalancer_backend_group_GetPropertySplitableExportOutput: {} + loadbalancer_backend_group_GetPropertySplitableOutput: {} + loadbalancer_backend_group_GetPropertyStatisticsOutput: + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_backend_group_GetPropertyTagValuePairsOutput: {} + loadbalancer_backend_group_GetPropertyTagValueTreeOutput: {} + loadbalancer_backend_group_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_backend_groups: + items: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_backend_group_PerformClassMetadataOutput: {} + loadbalancer_backend_group_PerformPurgeOutput: {} + loadbalancer_backend_group_PerformPurgeSplitableOutput: {} + loadbalancer_backend_group_PerformSetClassMetadataOutput: {} + loadbalancer_backend_group_PerformSetUserMetadataOutput: {} + loadbalancer_backend_group_PerformStatusOutput: {} + loadbalancer_backend_group_ValidateCreateDataOutput: + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: object + loadbalancer_backend_group_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer_backend_group: + $ref: '#/definitions/LoadbalancerBackendGroupDetails' + type: object + loadbalancer_certificate_CustomizeDeleteOutput: + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: object + loadbalancer_certificate_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: object + loadbalancer_certificate_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + loadbalancer_certificate_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_certificate_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_certificate_GetDetailsStatusOutput: + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_certificate_GetPropertyDistinctFieldOutput: {} + loadbalancer_certificate_GetPropertyDomainStatisticsOutput: + schema: + properties: + loadbalancer_certificate: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_certificate_GetPropertyProjectStatisticsOutput: + schema: + properties: + loadbalancer_certificate: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + loadbalancer_certificate_GetPropertyProjectTagValuePairsOutput: {} + loadbalancer_certificate_GetPropertyProjectTagValueTreeOutput: {} + loadbalancer_certificate_GetPropertySplitableExportOutput: {} + loadbalancer_certificate_GetPropertySplitableOutput: {} + loadbalancer_certificate_GetPropertyStatisticsOutput: + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_certificate_GetPropertyTagValuePairsOutput: {} + loadbalancer_certificate_GetPropertyTagValueTreeOutput: {} + loadbalancer_certificate_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_certificates: + items: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_certificate_PerformCancelDeleteOutput: {} + loadbalancer_certificate_PerformChangeOwnerOutput: {} + loadbalancer_certificate_PerformClassMetadataOutput: {} + loadbalancer_certificate_PerformFreezeOutput: {} + loadbalancer_certificate_PerformPrivateOutput: {} + loadbalancer_certificate_PerformPublicOutput: {} + loadbalancer_certificate_PerformPurgeSplitableOutput: {} + loadbalancer_certificate_PerformSetClassMetadataOutput: {} + loadbalancer_certificate_PerformSetUserMetadataOutput: {} + loadbalancer_certificate_PerformStatusOutput: {} + loadbalancer_certificate_PerformUnfreezeOutput: {} + loadbalancer_certificate_ValidateCreateDataOutput: + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: object + loadbalancer_certificate_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer_certificate: + $ref: '#/definitions/LoadbalancerCertificateDetails' + type: object + loadbalancer_cluster_CustomizeDeleteOutput: + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: object + loadbalancer_cluster_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: object + loadbalancer_cluster_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_cluster_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer_cluster: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_cluster_GetPropertyDistinctFieldOutput: {} + loadbalancer_cluster_GetPropertySplitableExportOutput: {} + loadbalancer_cluster_GetPropertySplitableOutput: {} + loadbalancer_cluster_GetPropertyTagValuePairsOutput: {} + loadbalancer_cluster_GetPropertyTagValueTreeOutput: {} + loadbalancer_cluster_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_clusters: + items: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_cluster_PerformClassMetadataOutput: {} + loadbalancer_cluster_PerformParamsPatchOutput: {} + loadbalancer_cluster_PerformPurgeSplitableOutput: {} + loadbalancer_cluster_PerformSetClassMetadataOutput: {} + loadbalancer_cluster_PerformSetUserMetadataOutput: {} + loadbalancer_cluster_ValidateCreateDataOutput: + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: object + loadbalancer_cluster_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer_cluster: + $ref: '#/definitions/LoadbalancerClusterDetails' + type: object + loadbalancer_listener_CustomizeDeleteOutput: + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: object + loadbalancer_listener_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: object + loadbalancer_listener_GetDetailsBackendStatusOutput: {} + loadbalancer_listener_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer_listener: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_GetDetailsStatusOutput: + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_listener_GetPropertyDistinctFieldOutput: {} + loadbalancer_listener_GetPropertySplitableExportOutput: {} + loadbalancer_listener_GetPropertySplitableOutput: {} + loadbalancer_listener_GetPropertyStatisticsOutput: + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_listener_GetPropertyTagValuePairsOutput: {} + loadbalancer_listener_GetPropertyTagValueTreeOutput: {} + loadbalancer_listener_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_listeners: + items: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_listener_PerformClassMetadataOutput: {} + loadbalancer_listener_PerformPurgeOutput: {} + loadbalancer_listener_PerformPurgeSplitableOutput: {} + loadbalancer_listener_PerformSetClassMetadataOutput: {} + loadbalancer_listener_PerformSetUserMetadataOutput: {} + loadbalancer_listener_PerformStatusOutput: {} + loadbalancer_listener_PerformSyncOutput: {} + loadbalancer_listener_PerformSyncstatusOutput: {} + loadbalancer_listener_ValidateCreateDataOutput: + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: object + loadbalancer_listener_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer_listener: + $ref: '#/definitions/LoadbalancerListenerDetails' + type: object + loadbalancer_listener_rule_CustomizeDeleteOutput: + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: object + loadbalancer_listener_rule_FetchCustomizeColumnsOutput: + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: object + loadbalancer_listener_rule_GetDetailsBackendStatusOutput: {} + loadbalancer_listener_rule_GetDetailsClassMetadataOutput: + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_rule_GetDetailsMetadataOutput: + schema: + properties: + loadbalancer_listener_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + loadbalancer_listener_rule_GetDetailsStatusOutput: + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + loadbalancer_listener_rule_GetPropertyDistinctFieldOutput: {} + loadbalancer_listener_rule_GetPropertySplitableExportOutput: {} + loadbalancer_listener_rule_GetPropertySplitableOutput: {} + loadbalancer_listener_rule_GetPropertyStatisticsOutput: + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/StatusStatistic' + type: object + loadbalancer_listener_rule_GetPropertyTagValuePairsOutput: {} + loadbalancer_listener_rule_GetPropertyTagValueTreeOutput: {} + loadbalancer_listener_rule_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + loadbalancer_listener_rules: + items: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + loadbalancer_listener_rule_PerformClassMetadataOutput: {} + loadbalancer_listener_rule_PerformPurgeOutput: {} + loadbalancer_listener_rule_PerformPurgeSplitableOutput: {} + loadbalancer_listener_rule_PerformSetClassMetadataOutput: {} + loadbalancer_listener_rule_PerformSetUserMetadataOutput: {} + loadbalancer_listener_rule_PerformStatusOutput: {} + loadbalancer_listener_rule_ValidateCreateDataOutput: + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: object + loadbalancer_listener_rule_ValidateUpdateDataOutput: + schema: + properties: + loadbalancer_listener_rule: + $ref: '#/definitions/LoadbalancerListenerRuleDetails' + type: object + misc_resource_CustomizeDeleteOutput: + schema: + properties: + misc_resource: + $ref: '#/definitions/MiscResourceDetails' + type: object + misc_resource_FetchCustomizeColumnsOutput: + schema: + properties: + misc_resource: + $ref: '#/definitions/MiscResourceDetails' + type: object + misc_resource_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + misc_resource: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + misc_resource_GetDetailsClassMetadataOutput: + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + misc_resource_GetDetailsMetadataOutput: + schema: + properties: + misc_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + misc_resource_GetDetailsStatusOutput: + schema: + properties: + misc_resource: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + misc_resource_GetPropertyDistinctFieldOutput: {} + misc_resource_GetPropertyDomainStatisticsOutput: + schema: + properties: + misc_resource: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + misc_resource_GetPropertyProjectStatisticsOutput: + schema: + properties: + misc_resource: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + misc_resource_GetPropertyProjectTagValuePairsOutput: {} + misc_resource_GetPropertyProjectTagValueTreeOutput: {} + misc_resource_GetPropertySplitableExportOutput: {} + misc_resource_GetPropertySplitableOutput: {} + misc_resource_GetPropertyStatisticsOutput: + schema: + properties: + misc_resource: + $ref: '#/definitions/StatusStatistic' + type: object + misc_resource_GetPropertyTagValuePairsOutput: {} + misc_resource_GetPropertyTagValueTreeOutput: {} + misc_resource_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + misc_resources: + items: + $ref: '#/definitions/MiscResourceDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + misc_resource_PerformCancelDeleteOutput: {} + misc_resource_PerformChangeOwnerOutput: {} + misc_resource_PerformClassMetadataOutput: {} + misc_resource_PerformFreezeOutput: {} + misc_resource_PerformPurgeSplitableOutput: {} + misc_resource_PerformSetClassMetadataOutput: {} + misc_resource_PerformSetUserMetadataOutput: {} + misc_resource_PerformStatusOutput: {} + misc_resource_PerformUnfreezeOutput: {} + misc_resource_ValidateCreateDataOutput: + schema: + properties: + misc_resource: + $ref: '#/definitions/MiscResourceDetails' + type: object + misc_resource_ValidateUpdateDataOutput: + schema: + properties: + misc_resource: + $ref: '#/definitions/MiscResourceDetails' + type: object + modelarts_pool_CustomizeDeleteOutput: + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolDetails' + type: object + modelarts_pool_FetchCustomizeColumnsOutput: + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolDetails' + type: object + modelarts_pool_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + modelarts_pool_GetDetailsClassMetadataOutput: + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_GetDetailsMetadataOutput: + schema: + properties: + modelarts_pool: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_GetDetailsStatusOutput: + schema: + properties: + modelarts_pool: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + modelarts_pool_GetPropertyDistinctFieldOutput: {} + modelarts_pool_GetPropertyDomainStatisticsOutput: + schema: + properties: + modelarts_pool: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + modelarts_pool_GetPropertyProjectStatisticsOutput: + schema: + properties: + modelarts_pool: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + modelarts_pool_GetPropertyProjectTagValuePairsOutput: {} + modelarts_pool_GetPropertyProjectTagValueTreeOutput: {} + modelarts_pool_GetPropertySplitableExportOutput: {} + modelarts_pool_GetPropertySplitableOutput: {} + modelarts_pool_GetPropertyStatisticsOutput: + schema: + properties: + modelarts_pool: + $ref: '#/definitions/StatusStatistic' + type: object + modelarts_pool_GetPropertyTagValuePairsOutput: {} + modelarts_pool_GetPropertyTagValueTreeOutput: {} + modelarts_pool_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + modelarts_pools: + items: + $ref: '#/definitions/ModelartsPoolDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + modelarts_pool_PerformCancelDeleteOutput: {} + modelarts_pool_PerformChangeConfigOutput: {} + modelarts_pool_PerformChangeOwnerOutput: {} + modelarts_pool_PerformClassMetadataOutput: {} + modelarts_pool_PerformFreezeOutput: {} + modelarts_pool_PerformPurgeSplitableOutput: {} + modelarts_pool_PerformSetClassMetadataOutput: {} + modelarts_pool_PerformSetUserMetadataOutput: {} + modelarts_pool_PerformStatusOutput: {} + modelarts_pool_PerformSyncstatusOutput: {} + modelarts_pool_PerformUnfreezeOutput: {} + modelarts_pool_ValidateCreateDataOutput: + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolDetails' + type: object + modelarts_pool_ValidateUpdateDataOutput: + schema: + properties: + modelarts_pool: + $ref: '#/definitions/ModelartsPoolDetails' + type: object + modelarts_pool_sku_CustomizeDeleteOutput: + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: object + modelarts_pool_sku_FetchCustomizeColumnsOutput: + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: object + modelarts_pool_sku_GetDetailsClassMetadataOutput: + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_sku_GetDetailsMetadataOutput: + schema: + properties: + modelarts_pool_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + modelarts_pool_sku_GetDetailsStatusOutput: + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + modelarts_pool_sku_GetPropertyDistinctFieldOutput: {} + modelarts_pool_sku_GetPropertySplitableExportOutput: {} + modelarts_pool_sku_GetPropertySplitableOutput: {} + modelarts_pool_sku_GetPropertyStatisticsOutput: + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/StatusStatistic' + type: object + modelarts_pool_sku_GetPropertyTagValuePairsOutput: {} + modelarts_pool_sku_GetPropertyTagValueTreeOutput: {} + modelarts_pool_sku_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + modelarts_pool_skus: + items: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + modelarts_pool_sku_PerformClassMetadataOutput: {} + modelarts_pool_sku_PerformDisableOutput: {} + modelarts_pool_sku_PerformEnableOutput: {} + modelarts_pool_sku_PerformPurgeSplitableOutput: {} + modelarts_pool_sku_PerformSetClassMetadataOutput: {} + modelarts_pool_sku_PerformSetUserMetadataOutput: {} + modelarts_pool_sku_PerformStatusOutput: {} + modelarts_pool_sku_ValidateCreateDataOutput: + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: object + modelarts_pool_sku_ValidateUpdateDataOutput: + schema: + properties: + modelarts_pool_sku: + $ref: '#/definitions/ModelartsPoolSkuDetails' + type: object + models_GetDomainQuotaOutput: + schema: + properties: + domain_quotas: + items: + $ref: '#/definitions/SDomainQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetInfrasQuotaOutput: + schema: + properties: + infras_quotas: + items: + $ref: '#/definitions/SInfrasQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetProjectQuotaOutput: + schema: + properties: + project_quotas: + items: + $ref: '#/definitions/SProjectQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetQuotaOutput: + schema: + properties: + quotas: + items: + $ref: '#/definitions/SQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetRegionQuotaOutput: + schema: + properties: + region_quotas: + items: + $ref: '#/definitions/SRegionQuotaDetail' + type: array + x-go-name: Output + type: object + models_GetZoneQuotaOutput: + schema: + properties: + zone_quotas: + items: + $ref: '#/definitions/SZoneQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListDomainQuotasOutput: + schema: + properties: + domain_quotas: + items: + $ref: '#/definitions/SDomainQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListInfrasQuotasOutput: + schema: + properties: + infras_quotas: + items: + $ref: '#/definitions/SInfrasQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListProjectQuotasOutput: + schema: + properties: + project_quotas: + items: + $ref: '#/definitions/SProjectQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListQuotasOutput: + schema: + properties: + quotas: + items: + $ref: '#/definitions/SQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListRegionQuotasOutput: + schema: + properties: + region_quotas: + items: + $ref: '#/definitions/SRegionQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListZoneQuotasOutput: + schema: + properties: + zone_quotas: + items: + $ref: '#/definitions/SZoneQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetDomainQuotasOutput: + schema: + properties: + domain_quotas: + items: + $ref: '#/definitions/SDomainQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetInfrasQuotasOutput: + schema: + properties: + infras_quotas: + items: + $ref: '#/definitions/SInfrasQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetProjectQuotasOutput: + schema: + properties: + project_quotas: + items: + $ref: '#/definitions/SProjectQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetQuotasOutput: + schema: + properties: + quotas: + items: + $ref: '#/definitions/SQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetRegionQuotasOutput: + schema: + properties: + region_quotas: + items: + $ref: '#/definitions/SRegionQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetZoneQuotasOutput: + schema: + properties: + zone_quotas: + items: + $ref: '#/definitions/SZoneQuotaDetail' + type: array + x-go-name: Output + type: object + mongo_db_CustomizeDeleteOutput: + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBDetails' + type: object + mongo_db_FetchCustomizeColumnsOutput: + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBDetails' + type: object + mongo_db_GetDetailsBackupsOutput: + schema: + properties: + mongo_db: + $ref: '#/definitions/SMongoDBBackups' + type: object + mongo_db_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + mongo_db: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + mongo_db_GetDetailsClassMetadataOutput: + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mongo_db_GetDetailsMetadataOutput: + schema: + properties: + mongo_db: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mongo_db_GetDetailsStatusOutput: + schema: + properties: + mongo_db: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + mongo_db_GetPropertyDistinctFieldOutput: {} + mongo_db_GetPropertyDomainStatisticsOutput: + schema: + properties: + mongo_db: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + mongo_db_GetPropertyProjectStatisticsOutput: + schema: + properties: + mongo_db: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + mongo_db_GetPropertyProjectTagValuePairsOutput: {} + mongo_db_GetPropertyProjectTagValueTreeOutput: {} + mongo_db_GetPropertySplitableExportOutput: {} + mongo_db_GetPropertySplitableOutput: {} + mongo_db_GetPropertyStatisticsOutput: + schema: + properties: + mongo_db: + $ref: '#/definitions/StatusStatistic' + type: object + mongo_db_GetPropertyTagValuePairsOutput: {} + mongo_db_GetPropertyTagValueTreeOutput: {} + mongo_db_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + mongo_dbs: + items: + $ref: '#/definitions/MongoDBDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + mongo_db_PerformCancelDeleteOutput: {} + mongo_db_PerformCancelExpireOutput: {} + mongo_db_PerformChangeOwnerOutput: {} + mongo_db_PerformClassMetadataOutput: {} + mongo_db_PerformFreezeOutput: {} + mongo_db_PerformPostpaidExpireOutput: {} + mongo_db_PerformPurgeSplitableOutput: {} + mongo_db_PerformRemoteUpdateOutput: {} + mongo_db_PerformSetClassMetadataOutput: {} + mongo_db_PerformSetUserMetadataOutput: {} + mongo_db_PerformStatusOutput: {} + mongo_db_PerformSyncstatusOutput: {} + mongo_db_PerformUnfreezeOutput: {} + mongo_db_ValidateCreateDataOutput: + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBDetails' + type: object + mongo_db_ValidateUpdateDataOutput: + schema: + properties: + mongo_db: + $ref: '#/definitions/MongoDBDetails' + type: object + mount_target_CustomizeDeleteOutput: + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetDetails' + type: object + mount_target_FetchCustomizeColumnsOutput: + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetDetails' + type: object + mount_target_GetDetailsClassMetadataOutput: + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mount_target_GetDetailsMetadataOutput: + schema: + properties: + mount_target: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + mount_target_GetDetailsStatusOutput: + schema: + properties: + mount_target: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + mount_target_GetPropertyDistinctFieldOutput: {} + mount_target_GetPropertySplitableExportOutput: {} + mount_target_GetPropertySplitableOutput: {} + mount_target_GetPropertyStatisticsOutput: + schema: + properties: + mount_target: + $ref: '#/definitions/StatusStatistic' + type: object + mount_target_GetPropertyTagValuePairsOutput: {} + mount_target_GetPropertyTagValueTreeOutput: {} + mount_target_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + mount_targets: + items: + $ref: '#/definitions/MountTargetDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + mount_target_PerformClassMetadataOutput: {} + mount_target_PerformPurgeSplitableOutput: {} + mount_target_PerformSetClassMetadataOutput: {} + mount_target_PerformSetUserMetadataOutput: {} + mount_target_PerformStatusOutput: {} + mount_target_PerformSyncstatusOutput: {} + mount_target_ValidateCreateDataOutput: + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetDetails' + type: object + mount_target_ValidateUpdateDataOutput: + schema: + properties: + mount_target: + $ref: '#/definitions/MountTargetDetails' + type: object + nas_sku_CustomizeDeleteOutput: + schema: + properties: + nas_sku: + $ref: '#/definitions/NasSkuDetails' + type: object + nas_sku_FetchCustomizeColumnsOutput: + schema: + properties: + nas_sku: + $ref: '#/definitions/NasSkuDetails' + type: object + nas_sku_GetDetailsClassMetadataOutput: + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nas_sku_GetDetailsMetadataOutput: + schema: + properties: + nas_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nas_sku_GetDetailsStatusOutput: + schema: + properties: + nas_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nas_sku_GetPropertyDistinctFieldOutput: {} + nas_sku_GetPropertySplitableExportOutput: {} + nas_sku_GetPropertySplitableOutput: {} + nas_sku_GetPropertyStatisticsOutput: + schema: + properties: + nas_sku: + $ref: '#/definitions/StatusStatistic' + type: object + nas_sku_GetPropertySyncTasksOutput: {} + nas_sku_GetPropertyTagValuePairsOutput: {} + nas_sku_GetPropertyTagValueTreeOutput: {} + nas_sku_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nas_skus: + items: + $ref: '#/definitions/NasSkuDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nas_sku_PerformClassMetadataOutput: {} + nas_sku_PerformDisableOutput: {} + nas_sku_PerformEnableOutput: {} + nas_sku_PerformPurgeSplitableOutput: {} + nas_sku_PerformSetClassMetadataOutput: {} + nas_sku_PerformSetUserMetadataOutput: {} + nas_sku_PerformStatusOutput: {} + nas_sku_PerformSyncSkusOutput: {} + nas_sku_ValidateCreateDataOutput: + schema: + properties: + nas_sku: + $ref: '#/definitions/NasSkuDetails' + type: object + nas_sku_ValidateUpdateDataOutput: + schema: + properties: + nas_sku: + $ref: '#/definitions/NasSkuDetails' + type: object + nat_dentry_CustomizeDeleteOutput: + schema: + properties: + nat_dentry: + $ref: '#/definitions/NatDEntryDetails' + type: object + nat_dentry_FetchCustomizeColumnsOutput: + schema: + properties: + nat_dentry: + $ref: '#/definitions/NatDEntryDetails' + type: object + nat_dentry_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + nat_dentry: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + nat_dentry_GetDetailsClassMetadataOutput: + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_dentry_GetDetailsMetadataOutput: + schema: + properties: + nat_dentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_dentry_GetDetailsStatusOutput: + schema: + properties: + nat_dentry: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_dentry_GetPropertyDistinctFieldOutput: {} + nat_dentry_GetPropertyDomainTagValuePairsOutput: {} + nat_dentry_GetPropertyDomainTagValueTreeOutput: {} + nat_dentry_GetPropertySplitableExportOutput: {} + nat_dentry_GetPropertySplitableOutput: {} + nat_dentry_GetPropertyStatisticsOutput: + schema: + properties: + nat_dentry: + $ref: '#/definitions/StatusStatistic' + type: object + nat_dentry_GetPropertyTagValuePairsOutput: {} + nat_dentry_GetPropertyTagValueTreeOutput: {} + nat_dentry_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_dentries: + items: + $ref: '#/definitions/NatDEntryDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_dentry_PerformChangeOwnerOutput: {} + nat_dentry_PerformClassMetadataOutput: {} + nat_dentry_PerformPrivateOutput: {} + nat_dentry_PerformPublicOutput: {} + nat_dentry_PerformPurgeSplitableOutput: {} + nat_dentry_PerformSetClassMetadataOutput: {} + nat_dentry_PerformSetUserMetadataOutput: {} + nat_dentry_PerformStatusOutput: {} + nat_dentry_ValidateCreateDataOutput: + schema: + properties: + nat_dentry: + $ref: '#/definitions/NatDEntryDetails' + type: object + nat_dentry_ValidateUpdateDataOutput: + schema: + properties: + nat_dentry: + $ref: '#/definitions/NatDEntryDetails' + type: object + nat_entry_CustomizeDeleteOutput: + schema: + properties: + nat_entry: + $ref: '#/definitions/NatEntryDetails' + type: object + nat_entry_FetchCustomizeColumnsOutput: + schema: + properties: + nat_entry: + $ref: '#/definitions/NatEntryDetails' + type: object + nat_entry_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + nat_entry: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + nat_entry_GetDetailsClassMetadataOutput: + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_entry_GetDetailsMetadataOutput: + schema: + properties: + nat_entry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_entry_GetDetailsStatusOutput: + schema: + properties: + nat_entry: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_entry_GetPropertyDistinctFieldOutput: {} + nat_entry_GetPropertyDomainTagValuePairsOutput: {} + nat_entry_GetPropertyDomainTagValueTreeOutput: {} + nat_entry_GetPropertySplitableExportOutput: {} + nat_entry_GetPropertySplitableOutput: {} + nat_entry_GetPropertyStatisticsOutput: + schema: + properties: + nat_entry: + $ref: '#/definitions/StatusStatistic' + type: object + nat_entry_GetPropertyTagValuePairsOutput: {} + nat_entry_GetPropertyTagValueTreeOutput: {} + nat_entry_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_entries: + items: + $ref: '#/definitions/NatEntryDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_entry_PerformChangeOwnerOutput: {} + nat_entry_PerformClassMetadataOutput: {} + nat_entry_PerformPrivateOutput: {} + nat_entry_PerformPublicOutput: {} + nat_entry_PerformPurgeSplitableOutput: {} + nat_entry_PerformSetClassMetadataOutput: {} + nat_entry_PerformSetUserMetadataOutput: {} + nat_entry_PerformStatusOutput: {} + nat_entry_ValidateCreateDataOutput: + schema: + properties: + nat_entry: + $ref: '#/definitions/NatEntryDetails' + type: object + nat_entry_ValidateUpdateDataOutput: + schema: + properties: + nat_entry: + $ref: '#/definitions/NatEntryDetails' + type: object + nat_gateway_CustomizeDeleteOutput: + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDetails' + type: object + nat_gateway_FetchCustomizeColumnsOutput: + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDetails' + type: object + nat_gateway_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + nat_gateway: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + nat_gateway_GetDetailsClassMetadataOutput: + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_gateway_GetDetailsMetadataOutput: + schema: + properties: + nat_gateway: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_gateway_GetDetailsStatusOutput: + schema: + properties: + nat_gateway: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_gateway_GetPropertyDistinctFieldOutput: {} + nat_gateway_GetPropertyDomainTagValuePairsOutput: {} + nat_gateway_GetPropertyDomainTagValueTreeOutput: {} + nat_gateway_GetPropertySplitableExportOutput: {} + nat_gateway_GetPropertySplitableOutput: {} + nat_gateway_GetPropertyStatisticsOutput: + schema: + properties: + nat_gateway: + $ref: '#/definitions/StatusStatistic' + type: object + nat_gateway_GetPropertyTagValuePairsOutput: {} + nat_gateway_GetPropertyTagValueTreeOutput: {} + nat_gateway_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_gateways: + items: + $ref: '#/definitions/NatgatewayDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_gateway_PerformCancelExpireOutput: {} + nat_gateway_PerformChangeOwnerOutput: {} + nat_gateway_PerformClassMetadataOutput: {} + nat_gateway_PerformDnatResourcesOutput: {} + nat_gateway_PerformPostpaidExpireOutput: {} + nat_gateway_PerformPrivateOutput: {} + nat_gateway_PerformPublicOutput: {} + nat_gateway_PerformPurgeSplitableOutput: {} + nat_gateway_PerformRemoteUpdateOutput: {} + nat_gateway_PerformRenewOutput: {} + nat_gateway_PerformSetAutoRenewOutput: {} + nat_gateway_PerformSetClassMetadataOutput: {} + nat_gateway_PerformSetUserMetadataOutput: {} + nat_gateway_PerformSnatResourcesOutput: {} + nat_gateway_PerformStatusOutput: {} + nat_gateway_PerformSyncstatusOutput: {} + nat_gateway_ValidateCreateDataOutput: + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDetails' + type: object + nat_gateway_ValidateUpdateDataOutput: + schema: + properties: + nat_gateway: + $ref: '#/definitions/NatgatewayDetails' + type: object + nat_sentry_CustomizeDeleteOutput: + schema: + properties: + nat_sentry: + $ref: '#/definitions/NatSEntryDetails' + type: object + nat_sentry_FetchCustomizeColumnsOutput: + schema: + properties: + nat_sentry: + $ref: '#/definitions/NatSEntryDetails' + type: object + nat_sentry_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + nat_sentry: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + nat_sentry_GetDetailsClassMetadataOutput: + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sentry_GetDetailsMetadataOutput: + schema: + properties: + nat_sentry: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sentry_GetDetailsStatusOutput: + schema: + properties: + nat_sentry: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_sentry_GetPropertyDistinctFieldOutput: {} + nat_sentry_GetPropertyDomainTagValuePairsOutput: {} + nat_sentry_GetPropertyDomainTagValueTreeOutput: {} + nat_sentry_GetPropertySplitableExportOutput: {} + nat_sentry_GetPropertySplitableOutput: {} + nat_sentry_GetPropertyStatisticsOutput: + schema: + properties: + nat_sentry: + $ref: '#/definitions/StatusStatistic' + type: object + nat_sentry_GetPropertyTagValuePairsOutput: {} + nat_sentry_GetPropertyTagValueTreeOutput: {} + nat_sentry_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_sentries: + items: + $ref: '#/definitions/NatSEntryDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_sentry_PerformChangeOwnerOutput: {} + nat_sentry_PerformClassMetadataOutput: {} + nat_sentry_PerformPrivateOutput: {} + nat_sentry_PerformPublicOutput: {} + nat_sentry_PerformPurgeSplitableOutput: {} + nat_sentry_PerformSetClassMetadataOutput: {} + nat_sentry_PerformSetUserMetadataOutput: {} + nat_sentry_PerformStatusOutput: {} + nat_sentry_ValidateCreateDataOutput: + schema: + properties: + nat_sentry: + $ref: '#/definitions/NatSEntryDetails' + type: object + nat_sentry_ValidateUpdateDataOutput: + schema: + properties: + nat_sentry: + $ref: '#/definitions/NatSEntryDetails' + type: object + nat_sku_CustomizeDeleteOutput: + schema: + properties: + nat_sku: + $ref: '#/definitions/NatSkuDetails' + type: object + nat_sku_FetchCustomizeColumnsOutput: + schema: + properties: + nat_sku: + $ref: '#/definitions/NatSkuDetails' + type: object + nat_sku_GetDetailsClassMetadataOutput: + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sku_GetDetailsMetadataOutput: + schema: + properties: + nat_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + nat_sku_GetDetailsStatusOutput: + schema: + properties: + nat_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + nat_sku_GetPropertyDistinctFieldOutput: {} + nat_sku_GetPropertySplitableExportOutput: {} + nat_sku_GetPropertySplitableOutput: {} + nat_sku_GetPropertyStatisticsOutput: + schema: + properties: + nat_sku: + $ref: '#/definitions/StatusStatistic' + type: object + nat_sku_GetPropertySyncTasksOutput: {} + nat_sku_GetPropertyTagValuePairsOutput: {} + nat_sku_GetPropertyTagValueTreeOutput: {} + nat_sku_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + nat_skus: + items: + $ref: '#/definitions/NatSkuDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + nat_sku_PerformClassMetadataOutput: {} + nat_sku_PerformDisableOutput: {} + nat_sku_PerformEnableOutput: {} + nat_sku_PerformPurgeSplitableOutput: {} + nat_sku_PerformSetClassMetadataOutput: {} + nat_sku_PerformSetUserMetadataOutput: {} + nat_sku_PerformStatusOutput: {} + nat_sku_PerformSyncSkusOutput: {} + nat_sku_ValidateCreateDataOutput: + schema: + properties: + nat_sku: + $ref: '#/definitions/NatSkuDetails' + type: object + nat_sku_ValidateUpdateDataOutput: + schema: + properties: + nat_sku: + $ref: '#/definitions/NatSkuDetails' + type: object + net_tap_flow_CustomizeDeleteOutput: + schema: + properties: + net_tap_flow: + $ref: '#/definitions/NetTapFlowDetails' + type: object + net_tap_flow_FetchCustomizeColumnsOutput: + schema: + properties: + net_tap_flow: + $ref: '#/definitions/NetTapFlowDetails' + type: object + net_tap_flow_GetDetailsClassMetadataOutput: + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_flow_GetDetailsMetadataOutput: + schema: + properties: + net_tap_flow: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_flow_GetDetailsStatusOutput: + schema: + properties: + net_tap_flow: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + net_tap_flow_GetPropertyDistinctFieldOutput: {} + net_tap_flow_GetPropertySplitableExportOutput: {} + net_tap_flow_GetPropertySplitableOutput: {} + net_tap_flow_GetPropertyStatisticsOutput: + schema: + properties: + net_tap_flow: + $ref: '#/definitions/StatusStatistic' + type: object + net_tap_flow_GetPropertyTagValuePairsOutput: {} + net_tap_flow_GetPropertyTagValueTreeOutput: {} + net_tap_flow_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + net_tap_flows: + items: + $ref: '#/definitions/NetTapFlowDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + net_tap_flow_PerformClassMetadataOutput: {} + net_tap_flow_PerformDisableOutput: {} + net_tap_flow_PerformEnableOutput: {} + net_tap_flow_PerformPurgeSplitableOutput: {} + net_tap_flow_PerformSetClassMetadataOutput: {} + net_tap_flow_PerformSetUserMetadataOutput: {} + net_tap_flow_PerformStatusOutput: {} + net_tap_flow_ValidateCreateDataOutput: + schema: + properties: + net_tap_flow: + $ref: '#/definitions/NetTapFlowDetails' + type: object + net_tap_flow_ValidateUpdateDataOutput: + schema: + properties: + net_tap_flow: + $ref: '#/definitions/NetTapFlowDetails' + type: object + net_tap_service_CustomizeDeleteOutput: + schema: + properties: + net_tap_service: + $ref: '#/definitions/NetTapServiceDetails' + type: object + net_tap_service_FetchCustomizeColumnsOutput: + schema: + properties: + net_tap_service: + $ref: '#/definitions/NetTapServiceDetails' + type: object + net_tap_service_GetDetailsClassMetadataOutput: + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_service_GetDetailsMetadataOutput: + schema: + properties: + net_tap_service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + net_tap_service_GetDetailsStatusOutput: + schema: + properties: + net_tap_service: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + net_tap_service_GetPropertyDistinctFieldOutput: {} + net_tap_service_GetPropertySplitableExportOutput: {} + net_tap_service_GetPropertySplitableOutput: {} + net_tap_service_GetPropertyStatisticsOutput: + schema: + properties: + net_tap_service: + $ref: '#/definitions/StatusStatistic' + type: object + net_tap_service_GetPropertyTagValuePairsOutput: {} + net_tap_service_GetPropertyTagValueTreeOutput: {} + net_tap_service_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + net_tap_services: + items: + $ref: '#/definitions/NetTapServiceDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + net_tap_service_PerformClassMetadataOutput: {} + net_tap_service_PerformDisableOutput: {} + net_tap_service_PerformEnableOutput: {} + net_tap_service_PerformPurgeSplitableOutput: {} + net_tap_service_PerformSetClassMetadataOutput: {} + net_tap_service_PerformSetUserMetadataOutput: {} + net_tap_service_PerformStatusOutput: {} + net_tap_service_ValidateCreateDataOutput: + schema: + properties: + net_tap_service: + $ref: '#/definitions/NetTapServiceDetails' + type: object + net_tap_service_ValidateUpdateDataOutput: + schema: + properties: + net_tap_service: + $ref: '#/definitions/NetTapServiceDetails' + type: object + network_CustomizeDeleteOutput: + schema: + properties: + network: + $ref: '#/definitions/NetworkDetails' + type: object + network_FetchCustomizeColumnsOutput: + schema: + properties: + network: + $ref: '#/definitions/NetworkDetails' + type: object + network_GetDetailsAddressesOutput: + schema: + properties: + network: + $ref: '#/definitions/GetNetworkAddressesOutput' + type: object + network_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + network: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + network_GetDetailsClassMetadataOutput: + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_GetDetailsMetadataOutput: + schema: + properties: + network: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_GetDetailsReservedIpsOutput: {} + network_GetDetailsStatusOutput: + schema: + properties: + network: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + network_GetPropertyDistinctFieldOutput: {} + network_GetPropertyDomainStatisticsOutput: + schema: + properties: + network: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + network_GetPropertyProjectStatisticsOutput: + schema: + properties: + network: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + network_GetPropertyProjectTagValuePairsOutput: {} + network_GetPropertyProjectTagValueTreeOutput: {} + network_GetPropertySplitableExportOutput: {} + network_GetPropertySplitableOutput: {} + network_GetPropertyStatisticsOutput: + schema: + properties: + network: + $ref: '#/definitions/StatusStatistic' + type: object + network_GetPropertyTagValuePairsOutput: {} + network_GetPropertyTagValueTreeOutput: {} + network_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + networks: + items: + $ref: '#/definitions/NetworkDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_PerformCancelDeleteOutput: {} + network_PerformChangeOwnerOutput: {} + network_PerformClassMetadataOutput: {} + network_PerformFreezeOutput: {} + network_PerformMergeOutput: {} + network_PerformPrivateOutput: {} + network_PerformPublicOutput: {} + network_PerformPurgeOutput: {} + network_PerformPurgeSplitableOutput: {} + network_PerformReleaseReservedIpOutput: {} + network_PerformReserveIpOutput: {} + network_PerformSetBgpTypeOutput: {} + network_PerformSetClassMetadataOutput: {} + network_PerformSetSchedtagOutput: {} + network_PerformSetUserMetadataOutput: {} + network_PerformSplitOutput: {} + network_PerformStatusOutput: {} + network_PerformSwitchWireOutput: {} + network_PerformSyncOutput: {} + network_PerformSyncstatusOutput: {} + network_PerformTryCreateNetworkOutput: {} + network_PerformUnfreezeOutput: {} + network_ValidateCreateDataOutput: + schema: + properties: + network: + $ref: '#/definitions/NetworkDetails' + type: object + network_ValidateUpdateDataOutput: + schema: + properties: + network: + $ref: '#/definitions/NetworkDetails' + type: object + network_address_CustomizeDeleteOutput: + schema: + properties: + network_address: + $ref: '#/definitions/NetworkAddressDetails' + type: object + network_address_FetchCustomizeColumnsOutput: + schema: + properties: + network_address: + $ref: '#/definitions/NetworkAddressDetails' + type: object + network_address_GetDetailsClassMetadataOutput: + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_address_GetDetailsMetadataOutput: + schema: + properties: + network_address: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_address_GetPropertyDistinctFieldOutput: {} + network_address_GetPropertySplitableExportOutput: {} + network_address_GetPropertySplitableOutput: {} + network_address_GetPropertyTagValuePairsOutput: {} + network_address_GetPropertyTagValueTreeOutput: {} + network_address_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + network_addresses: + items: + $ref: '#/definitions/NetworkAddressDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_address_PerformClassMetadataOutput: {} + network_address_PerformPurgeSplitableOutput: {} + network_address_PerformSetClassMetadataOutput: {} + network_address_PerformSetUserMetadataOutput: {} + network_address_ValidateCreateDataOutput: + schema: + properties: + network_address: + $ref: '#/definitions/NetworkAddressDetails' + type: object + network_address_ValidateUpdateDataOutput: + schema: + properties: + network_address: + $ref: '#/definitions/NetworkAddressDetails' + type: object + network_interface_CustomizeDeleteOutput: + schema: + properties: + network_interface: + $ref: '#/definitions/NetworkInterfaceDetails' + type: object + network_interface_FetchCustomizeColumnsOutput: + schema: + properties: + network_interface: + $ref: '#/definitions/NetworkInterfaceDetails' + type: object + network_interface_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + network_interface: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + network_interface_GetDetailsClassMetadataOutput: + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_interface_GetDetailsMetadataOutput: + schema: + properties: + network_interface: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_interface_GetDetailsStatusOutput: + schema: + properties: + network_interface: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + network_interface_GetPropertyDistinctFieldOutput: {} + network_interface_GetPropertyDomainTagValuePairsOutput: {} + network_interface_GetPropertyDomainTagValueTreeOutput: {} + network_interface_GetPropertySplitableExportOutput: {} + network_interface_GetPropertySplitableOutput: {} + network_interface_GetPropertyStatisticsOutput: + schema: + properties: + network_interface: + $ref: '#/definitions/StatusStatistic' + type: object + network_interface_GetPropertyTagValuePairsOutput: {} + network_interface_GetPropertyTagValueTreeOutput: {} + network_interface_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + network_interfaces: + items: + $ref: '#/definitions/NetworkInterfaceDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_interface_PerformChangeOwnerOutput: {} + network_interface_PerformClassMetadataOutput: {} + network_interface_PerformPrivateOutput: {} + network_interface_PerformPublicOutput: {} + network_interface_PerformPurgeSplitableOutput: {} + network_interface_PerformSetClassMetadataOutput: {} + network_interface_PerformSetUserMetadataOutput: {} + network_interface_PerformStatusOutput: {} + network_interface_ValidateCreateDataOutput: + schema: + properties: + network_interface: + $ref: '#/definitions/NetworkInterfaceDetails' + type: object + network_interface_ValidateUpdateDataOutput: + schema: + properties: + network_interface: + $ref: '#/definitions/NetworkInterfaceDetails' + type: object + network_ip_mac_CustomizeDeleteOutput: + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacDetails' + type: object + network_ip_mac_FetchCustomizeColumnsOutput: + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacDetails' + type: object + network_ip_mac_GetDetailsClassMetadataOutput: + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_ip_mac_GetDetailsMetadataOutput: + schema: + properties: + network_ip_mac: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + network_ip_mac_GetPropertyDistinctFieldOutput: {} + network_ip_mac_GetPropertySplitableExportOutput: {} + network_ip_mac_GetPropertySplitableOutput: {} + network_ip_mac_GetPropertyTagValuePairsOutput: {} + network_ip_mac_GetPropertyTagValueTreeOutput: {} + network_ip_mac_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + network_ip_macs: + items: + $ref: '#/definitions/NetworkIpMacDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + network_ip_mac_PerformBatchCreateOutput: {} + network_ip_mac_PerformClassMetadataOutput: {} + network_ip_mac_PerformPurgeSplitableOutput: {} + network_ip_mac_PerformSetClassMetadataOutput: {} + network_ip_mac_PerformSetUserMetadataOutput: {} + network_ip_mac_ValidateCreateDataOutput: + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacDetails' + type: object + network_ip_mac_ValidateUpdateDataOutput: + schema: + properties: + network_ip_mac: + $ref: '#/definitions/NetworkIpMacDetails' + type: object + networkinterfacenetwork_CustomizeDeleteOutput: + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + networkinterfacenetwork_FetchCustomizeColumnsOutput: + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + networkinterfacenetwork_GetPropertyDistinctFieldOutput: {} + networkinterfacenetwork_GetPropertySplitableExportOutput: {} + networkinterfacenetwork_GetPropertySplitableOutput: {} + networkinterfacenetwork_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + networkinterfacenetworks: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + networkinterfacenetwork_PerformPurgeSplitableOutput: {} + networkinterfacenetwork_ValidateCreateDataOutput: + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + networkinterfacenetwork_ValidateUpdateDataOutput: + schema: + properties: + networkinterfacenetwork: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + policy_assignment_CustomizeDeleteOutput: + schema: + properties: + policy_assignment: + $ref: '#/definitions/PolicyAssignmentDetails' + type: object + policy_assignment_FetchCustomizeColumnsOutput: + schema: + properties: + policy_assignment: + $ref: '#/definitions/PolicyAssignmentDetails' + type: object + policy_assignment_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + policy_assignment: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + policy_assignment_GetDetailsClassMetadataOutput: + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_assignment_GetDetailsMetadataOutput: + schema: + properties: + policy_assignment: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_assignment_GetPropertyDistinctFieldOutput: {} + policy_assignment_GetPropertyDomainTagValuePairsOutput: {} + policy_assignment_GetPropertyDomainTagValueTreeOutput: {} + policy_assignment_GetPropertySplitableExportOutput: {} + policy_assignment_GetPropertySplitableOutput: {} + policy_assignment_GetPropertyTagValuePairsOutput: {} + policy_assignment_GetPropertyTagValueTreeOutput: {} + policy_assignment_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + policy_assignments: + items: + $ref: '#/definitions/PolicyAssignmentDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + policy_assignment_PerformChangeOwnerOutput: {} + policy_assignment_PerformClassMetadataOutput: {} + policy_assignment_PerformPurgeSplitableOutput: {} + policy_assignment_PerformSetClassMetadataOutput: {} + policy_assignment_PerformSetUserMetadataOutput: {} + policy_assignment_ValidateCreateDataOutput: + schema: + properties: + policy_assignment: + $ref: '#/definitions/PolicyAssignmentDetails' + type: object + policy_assignment_ValidateUpdateDataOutput: + schema: + properties: + policy_assignment: + $ref: '#/definitions/PolicyAssignmentDetails' + type: object + policy_definition_CustomizeDeleteOutput: + schema: + properties: + policy_definition: + $ref: '#/definitions/PolicyDefinitionDetails' + type: object + policy_definition_FetchCustomizeColumnsOutput: + schema: + properties: + policy_definition: + $ref: '#/definitions/PolicyDefinitionDetails' + type: object + policy_definition_GetDetailsClassMetadataOutput: + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_definition_GetDetailsMetadataOutput: + schema: + properties: + policy_definition: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_definition_GetDetailsStatusOutput: + schema: + properties: + policy_definition: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + policy_definition_GetPropertyDistinctFieldOutput: {} + policy_definition_GetPropertySplitableExportOutput: {} + policy_definition_GetPropertySplitableOutput: {} + policy_definition_GetPropertyStatisticsOutput: + schema: + properties: + policy_definition: + $ref: '#/definitions/StatusStatistic' + type: object + policy_definition_GetPropertyTagValuePairsOutput: {} + policy_definition_GetPropertyTagValueTreeOutput: {} + policy_definition_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + policy_definitions: + items: + $ref: '#/definitions/PolicyDefinitionDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + policy_definition_PerformClassMetadataOutput: {} + policy_definition_PerformPurgeSplitableOutput: {} + policy_definition_PerformSetClassMetadataOutput: {} + policy_definition_PerformSetUserMetadataOutput: {} + policy_definition_PerformStatusOutput: {} + policy_definition_ValidateCreateDataOutput: + schema: + properties: + policy_definition: + $ref: '#/definitions/PolicyDefinitionDetails' + type: object + policy_definition_ValidateUpdateDataOutput: + schema: + properties: + policy_definition: + $ref: '#/definitions/PolicyDefinitionDetails' + type: object + project_mapping_CustomizeDeleteOutput: + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingDetails' + type: object + project_mapping_FetchCustomizeColumnsOutput: + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingDetails' + type: object + project_mapping_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + project_mapping: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + project_mapping_GetDetailsClassMetadataOutput: + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_mapping_GetDetailsMetadataOutput: + schema: + properties: + project_mapping: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_mapping_GetDetailsStatusOutput: + schema: + properties: + project_mapping: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + project_mapping_GetPropertyDistinctFieldOutput: {} + project_mapping_GetPropertyDomainTagValuePairsOutput: {} + project_mapping_GetPropertyDomainTagValueTreeOutput: {} + project_mapping_GetPropertySplitableExportOutput: {} + project_mapping_GetPropertySplitableOutput: {} + project_mapping_GetPropertyStatisticsOutput: + schema: + properties: + project_mapping: + $ref: '#/definitions/StatusStatistic' + type: object + project_mapping_GetPropertyTagValuePairsOutput: {} + project_mapping_GetPropertyTagValueTreeOutput: {} + project_mapping_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + project_mappings: + items: + $ref: '#/definitions/ProjectMappingDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + project_mapping_PerformChangeOwnerOutput: {} + project_mapping_PerformClassMetadataOutput: {} + project_mapping_PerformDisableOutput: {} + project_mapping_PerformEnableOutput: {} + project_mapping_PerformPrivateOutput: {} + project_mapping_PerformPublicOutput: {} + project_mapping_PerformPurgeSplitableOutput: {} + project_mapping_PerformSetClassMetadataOutput: {} + project_mapping_PerformSetUserMetadataOutput: {} + project_mapping_PerformStatusOutput: {} + project_mapping_ValidateCreateDataOutput: + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingDetails' + type: object + project_mapping_ValidateUpdateDataOutput: + schema: + properties: + project_mapping: + $ref: '#/definitions/ProjectMappingDetails' + type: object + reservedip_CustomizeDeleteOutput: + schema: + properties: + reservedip: + $ref: '#/definitions/ReservedipDetails' + type: object + reservedip_FetchCustomizeColumnsOutput: + schema: + properties: + reservedip: + $ref: '#/definitions/ReservedipDetails' + type: object + reservedip_GetPropertyDistinctFieldOutput: {} + reservedip_GetPropertySplitableExportOutput: {} + reservedip_GetPropertySplitableOutput: {} + reservedip_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + reservedips: + items: + $ref: '#/definitions/ReservedipDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + reservedip_PerformPurgeSplitableOutput: {} + reservedip_ValidateCreateDataOutput: + schema: + properties: + reservedip: + $ref: '#/definitions/ReservedipDetails' + type: object + reservedip_ValidateUpdateDataOutput: + schema: + properties: + reservedip: + $ref: '#/definitions/ReservedipDetails' + type: object + route_table_CustomizeDeleteOutput: + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableDetails' + type: object + route_table_FetchCustomizeColumnsOutput: + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableDetails' + type: object + route_table_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + route_table: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + route_table_GetDetailsClassMetadataOutput: + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_GetDetailsMetadataOutput: + schema: + properties: + route_table: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_GetDetailsStatusOutput: + schema: + properties: + route_table: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + route_table_GetPropertyDistinctFieldOutput: {} + route_table_GetPropertyDomainTagValuePairsOutput: {} + route_table_GetPropertyDomainTagValueTreeOutput: {} + route_table_GetPropertySplitableExportOutput: {} + route_table_GetPropertySplitableOutput: {} + route_table_GetPropertyStatisticsOutput: + schema: + properties: + route_table: + $ref: '#/definitions/StatusStatistic' + type: object + route_table_GetPropertyTagValuePairsOutput: {} + route_table_GetPropertyTagValueTreeOutput: {} + route_table_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + route_tables: + items: + $ref: '#/definitions/RouteTableDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + route_table_PerformAddRoutesOutput: {} + route_table_PerformChangeOwnerOutput: {} + route_table_PerformClassMetadataOutput: {} + route_table_PerformDelRoutesOutput: {} + route_table_PerformPrivateOutput: {} + route_table_PerformPublicOutput: {} + route_table_PerformPurgeOutput: {} + route_table_PerformPurgeSplitableOutput: {} + route_table_PerformSetClassMetadataOutput: {} + route_table_PerformSetUserMetadataOutput: {} + route_table_PerformStatusOutput: {} + route_table_PerformSyncstatusOutput: {} + route_table_ValidateCreateDataOutput: + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableDetails' + type: object + route_table_ValidateUpdateDataOutput: + schema: + properties: + route_table: + $ref: '#/definitions/RouteTableDetails' + type: object + route_table_association_CustomizeDeleteOutput: + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_association_FetchCustomizeColumnsOutput: + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_association_GetDetailsClassMetadataOutput: + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_association_GetDetailsMetadataOutput: + schema: + properties: + route_table_association: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_association_GetDetailsStatusOutput: + schema: + properties: + route_table_association: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + route_table_association_GetPropertyDistinctFieldOutput: {} + route_table_association_GetPropertySplitableExportOutput: {} + route_table_association_GetPropertySplitableOutput: {} + route_table_association_GetPropertyStatisticsOutput: + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStatistic' + type: object + route_table_association_GetPropertyTagValuePairsOutput: {} + route_table_association_GetPropertyTagValueTreeOutput: {} + route_table_association_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + route_table_associations: + items: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + route_table_association_PerformClassMetadataOutput: {} + route_table_association_PerformPurgeSplitableOutput: {} + route_table_association_PerformSetClassMetadataOutput: {} + route_table_association_PerformSetUserMetadataOutput: {} + route_table_association_PerformStatusOutput: {} + route_table_association_ValidateCreateDataOutput: + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_association_ValidateUpdateDataOutput: + schema: + properties: + route_table_association: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_route_set_CustomizeDeleteOutput: + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_route_set_FetchCustomizeColumnsOutput: + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_route_set_GetDetailsClassMetadataOutput: + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_route_set_GetDetailsMetadataOutput: + schema: + properties: + route_table_route_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + route_table_route_set_GetDetailsStatusOutput: + schema: + properties: + route_table_route_set: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + route_table_route_set_GetPropertyDistinctFieldOutput: {} + route_table_route_set_GetPropertySplitableExportOutput: {} + route_table_route_set_GetPropertySplitableOutput: {} + route_table_route_set_GetPropertyStatisticsOutput: + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStatistic' + type: object + route_table_route_set_GetPropertyTagValuePairsOutput: {} + route_table_route_set_GetPropertyTagValueTreeOutput: {} + route_table_route_set_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + route_table_route_sets: + items: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + route_table_route_set_PerformClassMetadataOutput: {} + route_table_route_set_PerformPurgeSplitableOutput: {} + route_table_route_set_PerformSetClassMetadataOutput: {} + route_table_route_set_PerformSetUserMetadataOutput: {} + route_table_route_set_PerformStatusOutput: {} + route_table_route_set_ValidateCreateDataOutput: + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + route_table_route_set_ValidateUpdateDataOutput: + schema: + properties: + route_table_route_set: + $ref: '#/definitions/StatusStandaloneResourceDetails' + type: object + scaling_activity_CustomizeDeleteOutput: + schema: + properties: + scaling_activity: + $ref: '#/definitions/ScalingActivityDetails' + type: object + scaling_activity_FetchCustomizeColumnsOutput: + schema: + properties: + scaling_activity: + $ref: '#/definitions/ScalingActivityDetails' + type: object + scaling_activity_GetDetailsClassMetadataOutput: + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_activity_GetDetailsMetadataOutput: + schema: + properties: + scaling_activity: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_activity_GetDetailsStatusOutput: + schema: + properties: + scaling_activity: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + scaling_activity_GetPropertyDistinctFieldOutput: {} + scaling_activity_GetPropertySplitableExportOutput: {} + scaling_activity_GetPropertySplitableOutput: {} + scaling_activity_GetPropertyStatisticsOutput: + schema: + properties: + scaling_activity: + $ref: '#/definitions/StatusStatistic' + type: object + scaling_activity_GetPropertyTagValuePairsOutput: {} + scaling_activity_GetPropertyTagValueTreeOutput: {} + scaling_activity_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_activities: + items: + $ref: '#/definitions/ScalingActivityDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_activity_PerformClassMetadataOutput: {} + scaling_activity_PerformPurgeSplitableOutput: {} + scaling_activity_PerformSetClassMetadataOutput: {} + scaling_activity_PerformSetUserMetadataOutput: {} + scaling_activity_PerformStatusOutput: {} + scaling_activity_ValidateCreateDataOutput: + schema: + properties: + scaling_activity: + $ref: '#/definitions/ScalingActivityDetails' + type: object + scaling_activity_ValidateUpdateDataOutput: + schema: + properties: + scaling_activity: + $ref: '#/definitions/ScalingActivityDetails' + type: object + scaling_alarm_CustomizeDeleteOutput: + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_alarm_FetchCustomizeColumnsOutput: + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_alarm_GetDetailsClassMetadataOutput: + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_alarm_GetDetailsMetadataOutput: + schema: + properties: + scaling_alarm: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_alarm_GetPropertyDistinctFieldOutput: {} + scaling_alarm_GetPropertySplitableExportOutput: {} + scaling_alarm_GetPropertySplitableOutput: {} + scaling_alarm_GetPropertyTagValuePairsOutput: {} + scaling_alarm_GetPropertyTagValueTreeOutput: {} + scaling_alarm_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_alarms: + items: + $ref: '#/definitions/StandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_alarm_PerformClassMetadataOutput: {} + scaling_alarm_PerformPurgeSplitableOutput: {} + scaling_alarm_PerformSetClassMetadataOutput: {} + scaling_alarm_PerformSetUserMetadataOutput: {} + scaling_alarm_ValidateCreateDataOutput: + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_alarm_ValidateUpdateDataOutput: + schema: + properties: + scaling_alarm: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_group_CustomizeDeleteOutput: + schema: + properties: + scaling_group: + $ref: '#/definitions/ScalingGroupDetails' + type: object + scaling_group_FetchCustomizeColumnsOutput: + schema: + properties: + scaling_group: + $ref: '#/definitions/ScalingGroupDetails' + type: object + scaling_group_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + scaling_group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + scaling_group_GetDetailsClassMetadataOutput: + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_group_GetDetailsMetadataOutput: + schema: + properties: + scaling_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_group_GetDetailsStatusOutput: + schema: + properties: + scaling_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + scaling_group_GetPropertyDistinctFieldOutput: {} + scaling_group_GetPropertyDomainStatisticsOutput: + schema: + properties: + scaling_group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + scaling_group_GetPropertyProjectStatisticsOutput: + schema: + properties: + scaling_group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + scaling_group_GetPropertyProjectTagValuePairsOutput: {} + scaling_group_GetPropertyProjectTagValueTreeOutput: {} + scaling_group_GetPropertySplitableExportOutput: {} + scaling_group_GetPropertySplitableOutput: {} + scaling_group_GetPropertyStatisticsOutput: + schema: + properties: + scaling_group: + $ref: '#/definitions/StatusStatistic' + type: object + scaling_group_GetPropertyTagValuePairsOutput: {} + scaling_group_GetPropertyTagValueTreeOutput: {} + scaling_group_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_groups: + items: + $ref: '#/definitions/ScalingGroupDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_group_PerformCancelDeleteOutput: {} + scaling_group_PerformChangeOwnerOutput: {} + scaling_group_PerformClassMetadataOutput: {} + scaling_group_PerformDisableOutput: {} + scaling_group_PerformEnableOutput: {} + scaling_group_PerformFreezeOutput: {} + scaling_group_PerformPurgeSplitableOutput: {} + scaling_group_PerformSetClassMetadataOutput: {} + scaling_group_PerformSetUserMetadataOutput: {} + scaling_group_PerformStatusOutput: {} + scaling_group_PerformUnfreezeOutput: {} + scaling_group_ValidateCreateDataOutput: + schema: + properties: + scaling_group: + $ref: '#/definitions/ScalingGroupDetails' + type: object + scaling_group_ValidateUpdateDataOutput: + schema: + properties: + scaling_group: + $ref: '#/definitions/ScalingGroupDetails' + type: object + scaling_group_guest_CustomizeDeleteOutput: + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointResourceDetails' + type: object + scaling_group_guest_FetchCustomizeColumnsOutput: + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointResourceDetails' + type: object + scaling_group_guest_GetPropertyDistinctFieldOutput: {} + scaling_group_guest_GetPropertySplitableExportOutput: {} + scaling_group_guest_GetPropertySplitableOutput: {} + scaling_group_guest_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_group_guests: + items: + $ref: '#/definitions/GuestJointResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_group_guest_PerformPurgeSplitableOutput: {} + scaling_group_guest_ValidateCreateDataOutput: + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointResourceDetails' + type: object + scaling_group_guest_ValidateUpdateDataOutput: + schema: + properties: + scaling_group_guest: + $ref: '#/definitions/GuestJointResourceDetails' + type: object + scaling_group_network_CustomizeDeleteOutput: + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + scaling_group_network_FetchCustomizeColumnsOutput: + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + scaling_group_network_GetPropertyDistinctFieldOutput: {} + scaling_group_network_GetPropertySplitableExportOutput: {} + scaling_group_network_GetPropertySplitableOutput: {} + scaling_group_network_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_group_networks: + items: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_group_network_PerformPurgeSplitableOutput: {} + scaling_group_network_ValidateCreateDataOutput: + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + scaling_group_network_ValidateUpdateDataOutput: + schema: + properties: + scaling_group_network: + $ref: '#/definitions/VirtualJointResourceBaseDetails' + type: object + scaling_policy_CustomizeDeleteOutput: + schema: + properties: + scaling_policy: + $ref: '#/definitions/ScalingPolicyDetails' + type: object + scaling_policy_FetchCustomizeColumnsOutput: + schema: + properties: + scaling_policy: + $ref: '#/definitions/ScalingPolicyDetails' + type: object + scaling_policy_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + scaling_policy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + scaling_policy_GetDetailsClassMetadataOutput: + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_policy_GetDetailsMetadataOutput: + schema: + properties: + scaling_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_policy_GetDetailsStatusOutput: + schema: + properties: + scaling_policy: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + scaling_policy_GetPropertyDistinctFieldOutput: {} + scaling_policy_GetPropertyDomainStatisticsOutput: + schema: + properties: + scaling_policy: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + scaling_policy_GetPropertyProjectStatisticsOutput: + schema: + properties: + scaling_policy: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + scaling_policy_GetPropertyProjectTagValuePairsOutput: {} + scaling_policy_GetPropertyProjectTagValueTreeOutput: {} + scaling_policy_GetPropertySplitableExportOutput: {} + scaling_policy_GetPropertySplitableOutput: {} + scaling_policy_GetPropertyStatisticsOutput: + schema: + properties: + scaling_policy: + $ref: '#/definitions/StatusStatistic' + type: object + scaling_policy_GetPropertyTagValuePairsOutput: {} + scaling_policy_GetPropertyTagValueTreeOutput: {} + scaling_policy_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_policies: + items: + $ref: '#/definitions/ScalingPolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_policy_PerformCancelDeleteOutput: {} + scaling_policy_PerformChangeOwnerOutput: {} + scaling_policy_PerformClassMetadataOutput: {} + scaling_policy_PerformDisableOutput: {} + scaling_policy_PerformEnableOutput: {} + scaling_policy_PerformFreezeOutput: {} + scaling_policy_PerformPurgeSplitableOutput: {} + scaling_policy_PerformSetClassMetadataOutput: {} + scaling_policy_PerformSetUserMetadataOutput: {} + scaling_policy_PerformStatusOutput: {} + scaling_policy_PerformTriggerOutput: {} + scaling_policy_PerformUnfreezeOutput: {} + scaling_policy_ValidateCreateDataOutput: + schema: + properties: + scaling_policy: + $ref: '#/definitions/ScalingPolicyDetails' + type: object + scaling_policy_ValidateUpdateDataOutput: + schema: + properties: + scaling_policy: + $ref: '#/definitions/ScalingPolicyDetails' + type: object + scaling_timer_CustomizeDeleteOutput: + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_timer_FetchCustomizeColumnsOutput: + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_timer_GetDetailsClassMetadataOutput: + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_timer_GetDetailsMetadataOutput: + schema: + properties: + scaling_timer: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scaling_timer_GetPropertyDistinctFieldOutput: {} + scaling_timer_GetPropertySplitableExportOutput: {} + scaling_timer_GetPropertySplitableOutput: {} + scaling_timer_GetPropertyTagValuePairsOutput: {} + scaling_timer_GetPropertyTagValueTreeOutput: {} + scaling_timer_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scaling_timers: + items: + $ref: '#/definitions/StandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scaling_timer_PerformClassMetadataOutput: {} + scaling_timer_PerformPurgeSplitableOutput: {} + scaling_timer_PerformSetClassMetadataOutput: {} + scaling_timer_PerformSetUserMetadataOutput: {} + scaling_timer_ValidateCreateDataOutput: + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + scaling_timer_ValidateUpdateDataOutput: + schema: + properties: + scaling_timer: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + schedpolicy_CustomizeDeleteOutput: + schema: + properties: + schedpolicy: + $ref: '#/definitions/SchedpolicyDetails' + type: object + schedpolicy_FetchCustomizeColumnsOutput: + schema: + properties: + schedpolicy: + $ref: '#/definitions/SchedpolicyDetails' + type: object + schedpolicy_GetDetailsClassMetadataOutput: + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedpolicy_GetDetailsMetadataOutput: + schema: + properties: + schedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedpolicy_GetPropertyDistinctFieldOutput: {} + schedpolicy_GetPropertySplitableExportOutput: {} + schedpolicy_GetPropertySplitableOutput: {} + schedpolicy_GetPropertyTagValuePairsOutput: {} + schedpolicy_GetPropertyTagValueTreeOutput: {} + schedpolicy_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + schedpolicies: + items: + $ref: '#/definitions/SchedpolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + schedpolicy_PerformClassMetadataOutput: {} + schedpolicy_PerformEvaluateOutput: {} + schedpolicy_PerformPurgeSplitableOutput: {} + schedpolicy_PerformSetClassMetadataOutput: {} + schedpolicy_PerformSetUserMetadataOutput: {} + schedpolicy_ValidateCreateDataOutput: + schema: + properties: + schedpolicy: + $ref: '#/definitions/SchedpolicyDetails' + type: object + schedpolicy_ValidateUpdateDataOutput: + schema: + properties: + schedpolicy: + $ref: '#/definitions/SchedpolicyDetails' + type: object + schedtag_CustomizeDeleteOutput: + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagDetails' + type: object + schedtag_FetchCustomizeColumnsOutput: + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagDetails' + type: object + schedtag_GetDetailsClassMetadataOutput: + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedtag_GetDetailsMetadataOutput: + schema: + properties: + schedtag: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + schedtag_GetPropertyDistinctFieldOutput: {} + schedtag_GetPropertySplitableExportOutput: {} + schedtag_GetPropertySplitableOutput: {} + schedtag_GetPropertyTagValuePairsOutput: {} + schedtag_GetPropertyTagValueTreeOutput: {} + schedtag_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + schedtags: + items: + $ref: '#/definitions/SchedtagDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + schedtag_PerformClassMetadataOutput: {} + schedtag_PerformPurgeSplitableOutput: {} + schedtag_PerformSetClassMetadataOutput: {} + schedtag_PerformSetResourceOutput: {} + schedtag_PerformSetScopeOutput: {} + schedtag_PerformSetUserMetadataOutput: {} + schedtag_ValidateCreateDataOutput: + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagDetails' + type: object + schedtag_ValidateUpdateDataOutput: + schema: + properties: + schedtag: + $ref: '#/definitions/SchedtagDetails' + type: object + security_group_CustomizeDeleteOutput: + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupDetails' + type: object + security_group_FetchCustomizeColumnsOutput: + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupDetails' + type: object + security_group_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + security_group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + security_group_GetDetailsClassMetadataOutput: + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + security_group_GetDetailsMetadataOutput: + schema: + properties: + security_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + security_group_GetDetailsStatusOutput: + schema: + properties: + security_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + security_group_GetPropertyDistinctFieldOutput: {} + security_group_GetPropertyDomainStatisticsOutput: + schema: + properties: + security_group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + security_group_GetPropertyProjectStatisticsOutput: + schema: + properties: + security_group: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + security_group_GetPropertyProjectTagValuePairsOutput: {} + security_group_GetPropertyProjectTagValueTreeOutput: {} + security_group_GetPropertySplitableExportOutput: {} + security_group_GetPropertySplitableOutput: {} + security_group_GetPropertyStatisticsOutput: + schema: + properties: + security_group: + $ref: '#/definitions/StatusStatistic' + type: object + security_group_GetPropertyTagValuePairsOutput: {} + security_group_GetPropertyTagValueTreeOutput: {} + security_group_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + security_groups: + items: + $ref: '#/definitions/SecgroupDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + security_group_PerformAddRuleOutput: {} + security_group_PerformCacheSecgroupOutput: {} + security_group_PerformCancelDeleteOutput: {} + security_group_PerformChangeOwnerOutput: {} + security_group_PerformClassMetadataOutput: {} + security_group_PerformCloneOutput: + schema: + properties: + security_group: + $ref: '#/definitions/SecurityGroupCloneInput' + type: object + security_group_PerformFreezeOutput: {} + security_group_PerformImportRulesOutput: {} + security_group_PerformMergeOutput: {} + security_group_PerformPrivateOutput: {} + security_group_PerformPublicOutput: {} + security_group_PerformPurgeOutput: {} + security_group_PerformPurgeSplitableOutput: {} + security_group_PerformSetClassMetadataOutput: {} + security_group_PerformSetUserMetadataOutput: {} + security_group_PerformStatusOutput: {} + security_group_PerformUncacheSecgroupOutput: {} + security_group_PerformUnfreezeOutput: {} + security_group_ValidateCreateDataOutput: + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupDetails' + type: object + security_group_ValidateUpdateDataOutput: + schema: + properties: + security_group: + $ref: '#/definitions/SecgroupDetails' + type: object + security_group_cache_CustomizeDeleteOutput: + schema: + properties: + security_group_cache: + $ref: '#/definitions/SecurityGroupCacheDetails' + type: object + security_group_cache_FetchCustomizeColumnsOutput: + schema: + properties: + security_group_cache: + $ref: '#/definitions/SecurityGroupCacheDetails' + type: object + security_group_cache_GetDetailsClassMetadataOutput: + schema: + properties: + security_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + security_group_cache_GetDetailsMetadataOutput: + schema: + properties: + security_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + security_group_cache_GetDetailsReferencesOutput: + schema: + properties: + security_group_cache: + items: + $ref: '#/definitions/SecurityGroupReference' + type: array + x-go-name: Output + type: object + security_group_cache_GetDetailsStatusOutput: + schema: + properties: + security_group_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + security_group_cache_GetPropertyDistinctFieldOutput: {} + security_group_cache_GetPropertySplitableExportOutput: {} + security_group_cache_GetPropertySplitableOutput: {} + security_group_cache_GetPropertyStatisticsOutput: + schema: + properties: + security_group_cache: + $ref: '#/definitions/StatusStatistic' + type: object + security_group_cache_GetPropertyTagValuePairsOutput: {} + security_group_cache_GetPropertyTagValueTreeOutput: {} + security_group_cache_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + security_group_caches: + items: + $ref: '#/definitions/SecurityGroupCacheDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + security_group_cache_PerformClassMetadataOutput: {} + security_group_cache_PerformPurgeSplitableOutput: {} + security_group_cache_PerformSetClassMetadataOutput: {} + security_group_cache_PerformSetUserMetadataOutput: {} + security_group_cache_PerformStatusOutput: {} + security_group_cache_PerformSyncstatusOutput: {} + security_group_cache_ValidateCreateDataOutput: + schema: + properties: + security_group_cache: + $ref: '#/definitions/SecurityGroupCacheDetails' + type: object + security_group_cache_ValidateUpdateDataOutput: + schema: + properties: + security_group_cache: + $ref: '#/definitions/SecurityGroupCacheDetails' + type: object + security_group_rule_CustomizeDeleteOutput: + schema: + properties: + security_group_rule: + $ref: '#/definitions/SecgroupRuleDetails' + type: object + security_group_rule_FetchCustomizeColumnsOutput: + schema: + properties: + security_group_rule: + $ref: '#/definitions/SecgroupRuleDetails' + type: object + security_group_rule_GetPropertyDistinctFieldOutput: {} + security_group_rule_GetPropertySplitableExportOutput: {} + security_group_rule_GetPropertySplitableOutput: {} + security_group_rule_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + security_group_rules: + items: + $ref: '#/definitions/SecgroupRuleDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + security_group_rule_PerformPurgeSplitableOutput: {} + security_group_rule_ValidateCreateDataOutput: + schema: + properties: + security_group_rule: + $ref: '#/definitions/SecgroupRuleDetails' + type: object + security_group_rule_ValidateUpdateDataOutput: + schema: + properties: + security_group_rule: + $ref: '#/definitions/SecgroupRuleDetails' + type: object + server_CustomizeDeleteOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerDetails' + type: object + server_FetchCustomizeColumnsOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerDetails' + type: object + server_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + server: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + server_GetDetailsClassMetadataOutput: + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_GetDetailsCpusetCoresOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerGetCPUSetCoresResp' + type: object + server_GetDetailsCreateParamsOutput: {} + server_GetDetailsDescOutput: {} + server_GetDetailsIsoOutput: {} + server_GetDetailsJnlpOutput: {} + server_GetDetailsMakeSshableCmdOutput: + schema: + properties: + server: + $ref: '#/definitions/GuestMakeSshableCmdOutput' + type: object + server_GetDetailsMetadataOutput: + schema: + properties: + server: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_GetDetailsQemuInfoOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerQemuInfo' + type: object + server_GetDetailsRemoteNicsOutput: {} + server_GetDetailsSshableOutput: {} + server_GetDetailsSshportOutput: + schema: + properties: + server: + $ref: '#/definitions/GuestSshportOutput' + type: object + server_GetDetailsStatusOutput: + schema: + properties: + server: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + server_GetDetailsTasksOutput: {} + server_GetDetailsVirtInstallOutput: {} + server_GetDetailsVncOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerVncOutput' + type: object + server_GetPropertyDistinctFieldOutput: {} + server_GetPropertyDomainStatisticsOutput: + schema: + properties: + server: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + server_GetPropertyProjectStatisticsOutput: + schema: + properties: + server: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + server_GetPropertyProjectTagValuePairsOutput: {} + server_GetPropertyProjectTagValueTreeOutput: {} + server_GetPropertySplitableExportOutput: {} + server_GetPropertySplitableOutput: {} + server_GetPropertyStatisticsOutput: + schema: + properties: + server: + $ref: '#/definitions/StatusStatistic' + type: object + server_GetPropertyTagValuePairsOutput: {} + server_GetPropertyTagValueTreeOutput: {} + server_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + servers: + items: + $ref: '#/definitions/ServerDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + server_PerformAddSecgroupOutput: {} + server_PerformAssignAdminSecgroupOutput: {} + server_PerformAssociateEipOutput: {} + server_PerformAttachIsolatedDeviceOutput: {} + server_PerformAttachdiskOutput: {} + server_PerformAttachnetworkOutput: + schema: + properties: + server: + $ref: '#/definitions/SGuest' + type: object + server_PerformBatchMigrateOutput: {} + server_PerformBatchSetUserMetadataOutput: {} + server_PerformBatchUserMetadataOutput: {} + server_PerformBindGroupsOutput: {} + server_PerformBlockMirrorReadyOutput: {} + server_PerformBlockStreamFailedOutput: {} + server_PerformCalculateRecordChecksumOutput: {} + server_PerformCancelDeleteOutput: {} + server_PerformCancelExpireOutput: {} + server_PerformCancelLiveMigrateOutput: {} + server_PerformChangeBandwidthOutput: {} + server_PerformChangeConfigOutput: {} + server_PerformChangeDiskStorageOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerChangeDiskStorageInput' + type: object + server_PerformChangeIpaddrOutput: {} + server_PerformChangeOwnerOutput: {} + server_PerformChangeStorageOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerChangeStorageInput' + type: object + server_PerformClassMetadataOutput: {} + server_PerformCloneOutput: {} + server_PerformCloseForwardOutput: {} + server_PerformConvertOutput: {} + server_PerformConvertToKvmOutput: {} + server_PerformCpusetOutput: {} + server_PerformCpusetRemoveOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerCPUSetRemoveResp' + type: object + server_PerformCreateBackupOutput: {} + server_PerformCreateEipOutput: {} + server_PerformCreatediskOutput: {} + server_PerformDelExtraOptionOutput: {} + server_PerformDeleteBackupOutput: {} + server_PerformDeployOutput: {} + server_PerformDetachIsolatedDeviceOutput: {} + server_PerformDetachScalingGroupOutput: {} + server_PerformDetachdiskOutput: {} + server_PerformDetachnetworkOutput: {} + server_PerformDirtyServerStartOutput: {} + server_PerformDirtyServerVerifyOutput: {} + server_PerformDissociateEipOutput: {} + server_PerformEjectisoOutput: {} + server_PerformEjectvfdOutput: {} + server_PerformEnableMemcleanOutput: {} + server_PerformEventOutput: {} + server_PerformFreezeOutput: {} + server_PerformHaveAgentOutput: + schema: + properties: + server: + $ref: '#/definitions/GuestHaveAgentOutput' + type: object + server_PerformImportFromLibvirtOutput: {} + server_PerformImportOutput: {} + server_PerformInsertisoOutput: {} + server_PerformInsertvfdOutput: {} + server_PerformInstanceBackupOutput: {} + server_PerformInstanceSnapshotOutput: {} + server_PerformInstanceSnapshotResetOutput: {} + server_PerformIoThrottleOutput: {} + server_PerformListForwardOutput: {} + server_PerformLiveMigrateOutput: {} + server_PerformMakeSshableOutput: + schema: + properties: + server: + $ref: '#/definitions/GuestMakeSshableOutput' + type: object + server_PerformMigrateForecastOutput: {} + server_PerformMigrateNetworkOutput: {} + server_PerformMigrateOutput: {} + server_PerformModifySrcCheckOutput: {} + server_PerformMonitorOutput: {} + server_PerformOpenForwardOutput: {} + server_PerformPostpaidExpireOutput: {} + server_PerformPrepaidRecycleOutput: {} + server_PerformProbeIsolatedDevicesOutput: {} + server_PerformPublicipToEipOutput: {} + server_PerformPurgeOutput: {} + server_PerformPurgeSplitableOutput: {} + server_PerformQgaCommandOutput: {} + server_PerformQgaSetPasswordOutput: {} + server_PerformRebuildRootOutput: + schema: + properties: + server: + $ref: '#/definitions/SGuest' + type: object + server_PerformRemoteUpdateOutput: {} + server_PerformRenewOutput: {} + server_PerformResetOutput: {} + server_PerformResizeDiskOutput: {} + server_PerformRestartOutput: {} + server_PerformResumeOutput: {} + server_PerformRevokeAdminSecgroupOutput: {} + server_PerformRevokeSecgroupOutput: {} + server_PerformSaveGuestImageOutput: {} + server_PerformSaveImageOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerSaveImageInput' + type: object + server_PerformSaveTemplateOutput: {} + server_PerformSendkeysOutput: {} + server_PerformSetAutoRenewOutput: {} + server_PerformSetBootIndexOutput: {} + server_PerformSetClassMetadataOutput: {} + server_PerformSetExtraOptionOutput: {} + server_PerformSetIsolatedDeviceOutput: {} + server_PerformSetLiveMigrateParamsOutput: {} + server_PerformSetPasswordOutput: {} + server_PerformSetQemuParamsOutput: {} + server_PerformSetSecgroupOutput: {} + server_PerformSetSshportOutput: {} + server_PerformSetUserMetadataOutput: {} + server_PerformSlaveBlockStreamReadyOutput: {} + server_PerformSnapshotAndCloneOutput: {} + server_PerformStartBackupOutput: {} + server_PerformStartOutput: {} + server_PerformStatusOutput: {} + server_PerformStopOutput: {} + server_PerformStreamDisksCompleteOutput: {} + server_PerformSuspendOutput: {} + server_PerformSwitchToBackupOutput: {} + server_PerformSyncFixNicsOutput: {} + server_PerformSyncOutput: {} + server_PerformSyncstatusOutput: {} + server_PerformUnbindGroupsOutput: {} + server_PerformUndoPrepaidRecycleOutput: {} + server_PerformUnfreezeOutput: {} + server_PerformUserDataOutput: {} + server_ValidateCreateDataOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerDetails' + type: object + server_ValidateUpdateDataOutput: + schema: + properties: + server: + $ref: '#/definitions/ServerDetails' + type: object + server_sku_CustomizeDeleteOutput: + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuDetails' + type: object + server_sku_FetchCustomizeColumnsOutput: + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuDetails' + type: object + server_sku_GetDetailsClassMetadataOutput: + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_sku_GetDetailsMetadataOutput: + schema: + properties: + server_sku: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + server_sku_GetDetailsStatusOutput: + schema: + properties: + server_sku: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + server_sku_GetPropertyDistinctFieldOutput: {} + server_sku_GetPropertyInstanceSpecsOutput: {} + server_sku_GetPropertySplitableExportOutput: {} + server_sku_GetPropertySplitableOutput: {} + server_sku_GetPropertyStatisticsOutput: + schema: + properties: + server_sku: + $ref: '#/definitions/StatusStatistic' + type: object + server_sku_GetPropertySyncTasksOutput: {} + server_sku_GetPropertyTagValuePairsOutput: {} + server_sku_GetPropertyTagValueTreeOutput: {} + server_sku_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + server_skus: + items: + $ref: '#/definitions/ServerSkuDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + server_sku_PerformClassMetadataOutput: {} + server_sku_PerformDisableOutput: {} + server_sku_PerformEnableOutput: {} + server_sku_PerformPurgeSplitableOutput: {} + server_sku_PerformSetClassMetadataOutput: {} + server_sku_PerformSetUserMetadataOutput: {} + server_sku_PerformStatusOutput: {} + server_sku_PerformSyncSkusOutput: {} + server_sku_ValidateCreateDataOutput: + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuDetails' + type: object + server_sku_ValidateUpdateDataOutput: + schema: + properties: + server_sku: + $ref: '#/definitions/ServerSkuDetails' + type: object + service_catalog_CustomizeDeleteOutput: + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDetails' + type: object + service_catalog_FetchCustomizeColumnsOutput: + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDetails' + type: object + service_catalog_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + service_catalog: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + service_catalog_GetDetailsClassMetadataOutput: + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_catalog_GetDetailsMetadataOutput: + schema: + properties: + service_catalog: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_catalog_GetDetailsStatusOutput: + schema: + properties: + service_catalog: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + service_catalog_GetPropertyDistinctFieldOutput: {} + service_catalog_GetPropertyDomainStatisticsOutput: + schema: + properties: + service_catalog: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + service_catalog_GetPropertyProjectStatisticsOutput: + schema: + properties: + service_catalog: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + service_catalog_GetPropertyProjectTagValuePairsOutput: {} + service_catalog_GetPropertyProjectTagValueTreeOutput: {} + service_catalog_GetPropertySplitableExportOutput: {} + service_catalog_GetPropertySplitableOutput: {} + service_catalog_GetPropertyStatisticsOutput: + schema: + properties: + service_catalog: + $ref: '#/definitions/StatusStatistic' + type: object + service_catalog_GetPropertyTagValuePairsOutput: {} + service_catalog_GetPropertyTagValueTreeOutput: {} + service_catalog_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + service_catalogs: + items: + $ref: '#/definitions/ServiceCatalogDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + service_catalog_PerformCancelDeleteOutput: {} + service_catalog_PerformChangeOwnerOutput: {} + service_catalog_PerformClassMetadataOutput: {} + service_catalog_PerformDeployOutput: {} + service_catalog_PerformFreezeOutput: {} + service_catalog_PerformPrivateOutput: {} + service_catalog_PerformPublicOutput: {} + service_catalog_PerformPurgeSplitableOutput: {} + service_catalog_PerformSetClassMetadataOutput: {} + service_catalog_PerformSetUserMetadataOutput: {} + service_catalog_PerformStatusOutput: {} + service_catalog_PerformUnfreezeOutput: {} + service_catalog_ValidateCreateDataOutput: + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDetails' + type: object + service_catalog_ValidateUpdateDataOutput: + schema: + properties: + service_catalog: + $ref: '#/definitions/ServiceCatalogDetails' + type: object + snapshot_CustomizeDeleteOutput: + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotDetails' + type: object + snapshot_FetchCustomizeColumnsOutput: + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotDetails' + type: object + snapshot_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + snapshot: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + snapshot_GetDetailsClassMetadataOutput: + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_GetDetailsMetadataOutput: + schema: + properties: + snapshot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_GetDetailsStatusOutput: + schema: + properties: + snapshot: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + snapshot_GetPropertyDistinctFieldOutput: {} + snapshot_GetPropertyDomainStatisticsOutput: + schema: + properties: + snapshot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + snapshot_GetPropertyMaxCountOutput: {} + snapshot_GetPropertyProjectStatisticsOutput: + schema: + properties: + snapshot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + snapshot_GetPropertyProjectTagValuePairsOutput: {} + snapshot_GetPropertyProjectTagValueTreeOutput: {} + snapshot_GetPropertySplitableExportOutput: {} + snapshot_GetPropertySplitableOutput: {} + snapshot_GetPropertyStatisticsOutput: + schema: + properties: + snapshot: + $ref: '#/definitions/StatusStatistic' + type: object + snapshot_GetPropertyTagValuePairsOutput: {} + snapshot_GetPropertyTagValueTreeOutput: {} + snapshot_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + snapshots: + items: + $ref: '#/definitions/SnapshotDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + snapshot_PerformCancelDeleteOutput: {} + snapshot_PerformChangeOwnerOutput: {} + snapshot_PerformClassMetadataOutput: {} + snapshot_PerformDeleteDiskSnapshotsOutput: {} + snapshot_PerformDeletedOutput: {} + snapshot_PerformFreezeOutput: {} + snapshot_PerformPurgeOutput: {} + snapshot_PerformPurgeSplitableOutput: {} + snapshot_PerformSetClassMetadataOutput: {} + snapshot_PerformSetUserMetadataOutput: {} + snapshot_PerformStatusOutput: {} + snapshot_PerformSyncstatusOutput: {} + snapshot_PerformUnfreezeOutput: {} + snapshot_ValidateCreateDataOutput: + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotDetails' + type: object + snapshot_ValidateUpdateDataOutput: + schema: + properties: + snapshot: + $ref: '#/definitions/SnapshotDetails' + type: object + snapshot_policy_CustomizeDeleteOutput: + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDetails' + type: object + snapshot_policy_FetchCustomizeColumnsOutput: + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDetails' + type: object + snapshot_policy_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + snapshot_policy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + snapshot_policy_GetDetailsClassMetadataOutput: + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_policy_GetDetailsMetadataOutput: + schema: + properties: + snapshot_policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_policy_GetDetailsStatusOutput: + schema: + properties: + snapshot_policy: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + snapshot_policy_GetPropertyDistinctFieldOutput: {} + snapshot_policy_GetPropertyDomainStatisticsOutput: + schema: + properties: + snapshot_policy: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + snapshot_policy_GetPropertyProjectStatisticsOutput: + schema: + properties: + snapshot_policy: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + snapshot_policy_GetPropertyProjectTagValuePairsOutput: {} + snapshot_policy_GetPropertyProjectTagValueTreeOutput: {} + snapshot_policy_GetPropertySplitableExportOutput: {} + snapshot_policy_GetPropertySplitableOutput: {} + snapshot_policy_GetPropertyStatisticsOutput: + schema: + properties: + snapshot_policy: + $ref: '#/definitions/StatusStatistic' + type: object + snapshot_policy_GetPropertyTagValuePairsOutput: {} + snapshot_policy_GetPropertyTagValueTreeOutput: {} + snapshot_policy_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + snapshot_policies: + items: + $ref: '#/definitions/SnapshotPolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + snapshot_policy_PerformBindDisksOutput: {} + snapshot_policy_PerformCacheOutput: {} + snapshot_policy_PerformCancelDeleteOutput: {} + snapshot_policy_PerformChangeOwnerOutput: {} + snapshot_policy_PerformClassMetadataOutput: {} + snapshot_policy_PerformFreezeOutput: {} + snapshot_policy_PerformPurgeSplitableOutput: {} + snapshot_policy_PerformSetClassMetadataOutput: {} + snapshot_policy_PerformSetUserMetadataOutput: {} + snapshot_policy_PerformStatusOutput: {} + snapshot_policy_PerformUnbindDisksOutput: {} + snapshot_policy_PerformUnfreezeOutput: {} + snapshot_policy_PerformUpdateOutput: {} + snapshot_policy_ValidateCreateDataOutput: + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDetails' + type: object + snapshot_policy_ValidateUpdateDataOutput: + schema: + properties: + snapshot_policy: + $ref: '#/definitions/SnapshotPolicyDetails' + type: object + snapshot_policy_cache_CustomizeDeleteOutput: + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/SnapshotPolicyCacheDetails' + type: object + snapshot_policy_cache_FetchCustomizeColumnsOutput: + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/SnapshotPolicyCacheDetails' + type: object + snapshot_policy_cache_GetDetailsClassMetadataOutput: + schema: + properties: + snapshot_policy_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_policy_cache_GetDetailsMetadataOutput: + schema: + properties: + snapshot_policy_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + snapshot_policy_cache_GetDetailsStatusOutput: + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + snapshot_policy_cache_GetPropertyDistinctFieldOutput: {} + snapshot_policy_cache_GetPropertySplitableExportOutput: {} + snapshot_policy_cache_GetPropertySplitableOutput: {} + snapshot_policy_cache_GetPropertyStatisticsOutput: + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/StatusStatistic' + type: object + snapshot_policy_cache_GetPropertyTagValuePairsOutput: {} + snapshot_policy_cache_GetPropertyTagValueTreeOutput: {} + snapshot_policy_cache_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + snapshot_policy_caches: + items: + $ref: '#/definitions/SnapshotPolicyCacheDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + snapshot_policy_cache_PerformClassMetadataOutput: {} + snapshot_policy_cache_PerformPurgeSplitableOutput: {} + snapshot_policy_cache_PerformSetClassMetadataOutput: {} + snapshot_policy_cache_PerformSetUserMetadataOutput: {} + snapshot_policy_cache_PerformStatusOutput: {} + snapshot_policy_cache_ValidateCreateDataOutput: + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/SnapshotPolicyCacheDetails' + type: object + snapshot_policy_cache_ValidateUpdateDataOutput: + schema: + properties: + snapshot_policy_cache: + $ref: '#/definitions/SnapshotPolicyCacheDetails' + type: object + snapshot_policy_disk_CustomizeDeleteOutput: + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/SnapshotPolicyDiskDetails' + type: object + snapshot_policy_disk_FetchCustomizeColumnsOutput: + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/SnapshotPolicyDiskDetails' + type: object + snapshot_policy_disk_GetPropertyDistinctFieldOutput: {} + snapshot_policy_disk_GetPropertySplitableExportOutput: {} + snapshot_policy_disk_GetPropertySplitableOutput: {} + snapshot_policy_disk_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + snapshot_policy_disks: + items: + $ref: '#/definitions/SnapshotPolicyDiskDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + snapshot_policy_disk_PerformPurgeSplitableOutput: {} + snapshot_policy_disk_ValidateCreateDataOutput: + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/SnapshotPolicyDiskDetails' + type: object + snapshot_policy_disk_ValidateUpdateDataOutput: + schema: + properties: + snapshot_policy_disk: + $ref: '#/definitions/SnapshotPolicyDiskDetails' + type: object + storage_CustomizeDeleteOutput: + schema: + properties: + storage: + $ref: '#/definitions/StorageDetails' + type: object + storage_FetchCustomizeColumnsOutput: + schema: + properties: + storage: + $ref: '#/definitions/StorageDetails' + type: object + storage_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + storage: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + storage_GetDetailsClassMetadataOutput: + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storage_GetDetailsMetadataOutput: + schema: + properties: + storage: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storage_GetDetailsStatusOutput: + schema: + properties: + storage: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + storage_GetPropertyDistinctFieldOutput: {} + storage_GetPropertyDomainTagValuePairsOutput: {} + storage_GetPropertyDomainTagValueTreeOutput: {} + storage_GetPropertySplitableExportOutput: {} + storage_GetPropertySplitableOutput: {} + storage_GetPropertyStatisticsOutput: + schema: + properties: + storage: + $ref: '#/definitions/StatusStatistic' + type: object + storage_GetPropertyTagValuePairsOutput: {} + storage_GetPropertyTagValueTreeOutput: {} + storage_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + storages: + items: + $ref: '#/definitions/StorageDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + storage_PerformCacheImageOutput: {} + storage_PerformChangeOwnerOutput: {} + storage_PerformClassMetadataOutput: {} + storage_PerformDisableOutput: {} + storage_PerformEnableOutput: {} + storage_PerformForceDetachHostOutput: {} + storage_PerformOfflineOutput: {} + storage_PerformOnlineOutput: {} + storage_PerformPrivateOutput: {} + storage_PerformPublicOutput: {} + storage_PerformPurgeSplitableOutput: {} + storage_PerformSetClassMetadataOutput: {} + storage_PerformSetSchedtagOutput: {} + storage_PerformSetUserMetadataOutput: {} + storage_PerformStatusOutput: {} + storage_PerformUncacheImageOutput: {} + storage_ValidateCreateDataOutput: + schema: + properties: + storage: + $ref: '#/definitions/StorageDetails' + type: object + storage_ValidateUpdateDataOutput: + schema: + properties: + storage: + $ref: '#/definitions/StorageDetails' + type: object + storagecache_CustomizeDeleteOutput: + schema: + properties: + storagecache: + $ref: '#/definitions/StoragecacheDetails' + type: object + storagecache_FetchCustomizeColumnsOutput: + schema: + properties: + storagecache: + $ref: '#/definitions/StoragecacheDetails' + type: object + storagecache_GetDetailsClassMetadataOutput: + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storagecache_GetDetailsMetadataOutput: + schema: + properties: + storagecache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + storagecache_GetPropertyDistinctFieldOutput: {} + storagecache_GetPropertySplitableExportOutput: {} + storagecache_GetPropertySplitableOutput: {} + storagecache_GetPropertyTagValuePairsOutput: {} + storagecache_GetPropertyTagValueTreeOutput: {} + storagecache_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + storagecaches: + items: + $ref: '#/definitions/StoragecacheDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + storagecache_PerformCacheImageOutput: {} + storagecache_PerformClassMetadataOutput: {} + storagecache_PerformPurgeSplitableOutput: {} + storagecache_PerformSetClassMetadataOutput: {} + storagecache_PerformSetUserMetadataOutput: {} + storagecache_PerformUncacheImageOutput: {} + storagecache_ValidateCreateDataOutput: + schema: + properties: + storagecache: + $ref: '#/definitions/StoragecacheDetails' + type: object + storagecache_ValidateUpdateDataOutput: + schema: + properties: + storagecache: + $ref: '#/definitions/StoragecacheDetails' + type: object + storagecachedimage_CustomizeDeleteOutput: + schema: + properties: + storagecachedimage: + $ref: '#/definitions/StoragecachedimageDetails' + type: object + storagecachedimage_FetchCustomizeColumnsOutput: + schema: + properties: + storagecachedimage: + $ref: '#/definitions/StoragecachedimageDetails' + type: object + storagecachedimage_GetPropertyDistinctFieldOutput: {} + storagecachedimage_GetPropertySplitableExportOutput: {} + storagecachedimage_GetPropertySplitableOutput: {} + storagecachedimage_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + storagecachedimages: + items: + $ref: '#/definitions/StoragecachedimageDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + storagecachedimage_PerformPurgeSplitableOutput: {} + storagecachedimage_ValidateCreateDataOutput: + schema: + properties: + storagecachedimage: + $ref: '#/definitions/StoragecachedimageDetails' + type: object + storagecachedimage_ValidateUpdateDataOutput: + schema: + properties: + storagecachedimage: + $ref: '#/definitions/StoragecachedimageDetails' + type: object + tablestore_CustomizeDeleteOutput: + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreDetails' + type: object + tablestore_FetchCustomizeColumnsOutput: + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreDetails' + type: object + tablestore_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + tablestore: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + tablestore_GetDetailsClassMetadataOutput: + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + tablestore_GetDetailsMetadataOutput: + schema: + properties: + tablestore: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + tablestore_GetDetailsStatusOutput: + schema: + properties: + tablestore: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + tablestore_GetPropertyDistinctFieldOutput: {} + tablestore_GetPropertyDomainStatisticsOutput: + schema: + properties: + tablestore: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + tablestore_GetPropertyProjectStatisticsOutput: + schema: + properties: + tablestore: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + tablestore_GetPropertyProjectTagValuePairsOutput: {} + tablestore_GetPropertyProjectTagValueTreeOutput: {} + tablestore_GetPropertySplitableExportOutput: {} + tablestore_GetPropertySplitableOutput: {} + tablestore_GetPropertyStatisticsOutput: + schema: + properties: + tablestore: + $ref: '#/definitions/StatusStatistic' + type: object + tablestore_GetPropertyTagValuePairsOutput: {} + tablestore_GetPropertyTagValueTreeOutput: {} + tablestore_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + tablestores: + items: + $ref: '#/definitions/TablestoreDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + tablestore_PerformCancelDeleteOutput: {} + tablestore_PerformChangeOwnerOutput: {} + tablestore_PerformClassMetadataOutput: {} + tablestore_PerformFreezeOutput: {} + tablestore_PerformPurgeSplitableOutput: {} + tablestore_PerformSetClassMetadataOutput: {} + tablestore_PerformSetUserMetadataOutput: {} + tablestore_PerformStatusOutput: {} + tablestore_PerformUnfreezeOutput: {} + tablestore_ValidateCreateDataOutput: + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreDetails' + type: object + tablestore_ValidateUpdateDataOutput: + schema: + properties: + tablestore: + $ref: '#/definitions/TablestoreDetails' + type: object + vpc_CustomizeDeleteOutput: + schema: + properties: + vpc: + $ref: '#/definitions/VpcDetails' + type: object + vpc_FetchCustomizeColumnsOutput: + schema: + properties: + vpc: + $ref: '#/definitions/VpcDetails' + type: object + vpc_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + vpc: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + vpc_GetDetailsClassMetadataOutput: + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_GetDetailsMetadataOutput: + schema: + properties: + vpc: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_GetDetailsStatusOutput: + schema: + properties: + vpc: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + vpc_GetDetailsTopologyOutput: + schema: + properties: + vpc: + $ref: '#/definitions/VpcTopologyOutput' + type: object + vpc_GetPropertyDistinctFieldOutput: {} + vpc_GetPropertyDomainTagValuePairsOutput: {} + vpc_GetPropertyDomainTagValueTreeOutput: {} + vpc_GetPropertySplitableExportOutput: {} + vpc_GetPropertySplitableOutput: {} + vpc_GetPropertyStatisticsOutput: + schema: + properties: + vpc: + $ref: '#/definitions/StatusStatistic' + type: object + vpc_GetPropertyTagValuePairsOutput: {} + vpc_GetPropertyTagValueTreeOutput: {} + vpc_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + vpcs: + items: + $ref: '#/definitions/VpcDetails' + type: array + x-go-name: Output + type: object + vpc_PerformChangeOwnerOutput: {} + vpc_PerformClassMetadataOutput: {} + vpc_PerformDisableOutput: {} + vpc_PerformEnableOutput: {} + vpc_PerformPrivateOutput: {} + vpc_PerformPublicOutput: {} + vpc_PerformPurgeOutput: {} + vpc_PerformPurgeSplitableOutput: {} + vpc_PerformSetClassMetadataOutput: {} + vpc_PerformSetUserMetadataOutput: {} + vpc_PerformStatusOutput: {} + vpc_PerformSyncOutput: {} + vpc_PerformSyncstatusOutput: {} + vpc_ValidateCreateDataOutput: + schema: + properties: + vpc: + $ref: '#/definitions/VpcDetails' + type: object + vpc_ValidateUpdateDataOutput: + schema: + properties: + vpc: + $ref: '#/definitions/VpcDetails' + type: object + vpc_peering_connection_CustomizeDeleteOutput: + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: object + vpc_peering_connection_FetchCustomizeColumnsOutput: + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: object + vpc_peering_connection_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + vpc_peering_connection_GetDetailsClassMetadataOutput: + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_peering_connection_GetDetailsMetadataOutput: + schema: + properties: + vpc_peering_connection: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + vpc_peering_connection_GetDetailsStatusOutput: + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + vpc_peering_connection_GetPropertyDistinctFieldOutput: {} + vpc_peering_connection_GetPropertyDomainTagValuePairsOutput: {} + vpc_peering_connection_GetPropertyDomainTagValueTreeOutput: {} + vpc_peering_connection_GetPropertySplitableExportOutput: {} + vpc_peering_connection_GetPropertySplitableOutput: {} + vpc_peering_connection_GetPropertyStatisticsOutput: + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/StatusStatistic' + type: object + vpc_peering_connection_GetPropertyTagValuePairsOutput: {} + vpc_peering_connection_GetPropertyTagValueTreeOutput: {} + vpc_peering_connection_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + vpc_peering_connections: + items: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: array + x-go-name: Output + type: object + vpc_peering_connection_PerformChangeOwnerOutput: {} + vpc_peering_connection_PerformClassMetadataOutput: {} + vpc_peering_connection_PerformDisableOutput: {} + vpc_peering_connection_PerformEnableOutput: {} + vpc_peering_connection_PerformPrivateOutput: {} + vpc_peering_connection_PerformPublicOutput: {} + vpc_peering_connection_PerformPurgeSplitableOutput: {} + vpc_peering_connection_PerformSetClassMetadataOutput: {} + vpc_peering_connection_PerformSetUserMetadataOutput: {} + vpc_peering_connection_PerformStatusOutput: {} + vpc_peering_connection_PerformSyncstatusOutput: {} + vpc_peering_connection_ValidateCreateDataOutput: + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: object + vpc_peering_connection_ValidateUpdateDataOutput: + schema: + properties: + vpc_peering_connection: + $ref: '#/definitions/VpcPeeringConnectionDetails' + type: object + waf_instance_CustomizeDeleteOutput: + schema: + properties: + waf_instance: + $ref: '#/definitions/WafInstanceDetails' + type: object + waf_instance_FetchCustomizeColumnsOutput: + schema: + properties: + waf_instance: + $ref: '#/definitions/WafInstanceDetails' + type: object + waf_instance_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + waf_instance: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + waf_instance_GetDetailsClassMetadataOutput: + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_instance_GetDetailsCloudResourcesOutput: + schema: + properties: + waf_instance: + $ref: '#/definitions/SCloudResources' + type: object + waf_instance_GetDetailsMetadataOutput: + schema: + properties: + waf_instance: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_instance_GetDetailsStatusOutput: + schema: + properties: + waf_instance: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_instance_GetPropertyDistinctFieldOutput: {} + waf_instance_GetPropertyDomainTagValuePairsOutput: {} + waf_instance_GetPropertyDomainTagValueTreeOutput: {} + waf_instance_GetPropertySplitableExportOutput: {} + waf_instance_GetPropertySplitableOutput: {} + waf_instance_GetPropertyStatisticsOutput: + schema: + properties: + waf_instance: + $ref: '#/definitions/StatusStatistic' + type: object + waf_instance_GetPropertyTagValuePairsOutput: {} + waf_instance_GetPropertyTagValueTreeOutput: {} + waf_instance_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_instances: + items: + $ref: '#/definitions/WafInstanceDetails' + type: array + x-go-name: Output + type: object + waf_instance_PerformChangeOwnerOutput: {} + waf_instance_PerformClassMetadataOutput: {} + waf_instance_PerformDisableOutput: {} + waf_instance_PerformEnableOutput: {} + waf_instance_PerformPrivateOutput: {} + waf_instance_PerformPublicOutput: {} + waf_instance_PerformPurgeSplitableOutput: {} + waf_instance_PerformRemoteUpdateOutput: {} + waf_instance_PerformSetClassMetadataOutput: {} + waf_instance_PerformSetUserMetadataOutput: {} + waf_instance_PerformStatusOutput: {} + waf_instance_PerformSyncstatusOutput: {} + waf_instance_ValidateCreateDataOutput: + schema: + properties: + waf_instance: + $ref: '#/definitions/WafInstanceDetails' + type: object + waf_instance_ValidateUpdateDataOutput: + schema: + properties: + waf_instance: + $ref: '#/definitions/WafInstanceDetails' + type: object + waf_ip_set_CustomizeDeleteOutput: + schema: + properties: + waf_ip_set: + $ref: '#/definitions/WafIPSetDetails' + type: object + waf_ip_set_FetchCustomizeColumnsOutput: + schema: + properties: + waf_ip_set: + $ref: '#/definitions/WafIPSetDetails' + type: object + waf_ip_set_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + waf_ip_set: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + waf_ip_set_GetDetailsClassMetadataOutput: + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_GetDetailsMetadataOutput: + schema: + properties: + waf_ip_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_GetDetailsStatusOutput: + schema: + properties: + waf_ip_set: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_ip_set_GetPropertyDistinctFieldOutput: {} + waf_ip_set_GetPropertyDomainTagValuePairsOutput: {} + waf_ip_set_GetPropertyDomainTagValueTreeOutput: {} + waf_ip_set_GetPropertySplitableExportOutput: {} + waf_ip_set_GetPropertySplitableOutput: {} + waf_ip_set_GetPropertyStatisticsOutput: + schema: + properties: + waf_ip_set: + $ref: '#/definitions/StatusStatistic' + type: object + waf_ip_set_GetPropertyTagValuePairsOutput: {} + waf_ip_set_GetPropertyTagValueTreeOutput: {} + waf_ip_set_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_ip_sets: + items: + $ref: '#/definitions/WafIPSetDetails' + type: array + x-go-name: Output + type: object + waf_ip_set_PerformChangeOwnerOutput: {} + waf_ip_set_PerformClassMetadataOutput: {} + waf_ip_set_PerformPrivateOutput: {} + waf_ip_set_PerformPublicOutput: {} + waf_ip_set_PerformPurgeSplitableOutput: {} + waf_ip_set_PerformSetClassMetadataOutput: {} + waf_ip_set_PerformSetUserMetadataOutput: {} + waf_ip_set_PerformStatusOutput: {} + waf_ip_set_ValidateCreateDataOutput: + schema: + properties: + waf_ip_set: + $ref: '#/definitions/WafIPSetDetails' + type: object + waf_ip_set_ValidateUpdateDataOutput: + schema: + properties: + waf_ip_set: + $ref: '#/definitions/WafIPSetDetails' + type: object + waf_ip_set_cache_CustomizeDeleteOutput: + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/WafIPSetCacheDetails' + type: object + waf_ip_set_cache_FetchCustomizeColumnsOutput: + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/WafIPSetCacheDetails' + type: object + waf_ip_set_cache_GetDetailsClassMetadataOutput: + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_cache_GetDetailsMetadataOutput: + schema: + properties: + waf_ip_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_ip_set_cache_GetDetailsStatusOutput: + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_ip_set_cache_GetPropertyDistinctFieldOutput: {} + waf_ip_set_cache_GetPropertySplitableExportOutput: {} + waf_ip_set_cache_GetPropertySplitableOutput: {} + waf_ip_set_cache_GetPropertyStatisticsOutput: + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/StatusStatistic' + type: object + waf_ip_set_cache_GetPropertyTagValuePairsOutput: {} + waf_ip_set_cache_GetPropertyTagValueTreeOutput: {} + waf_ip_set_cache_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_ip_set_caches: + items: + $ref: '#/definitions/WafIPSetCacheDetails' + type: array + x-go-name: Output + type: object + waf_ip_set_cache_PerformClassMetadataOutput: {} + waf_ip_set_cache_PerformPurgeSplitableOutput: {} + waf_ip_set_cache_PerformSetClassMetadataOutput: {} + waf_ip_set_cache_PerformSetUserMetadataOutput: {} + waf_ip_set_cache_PerformStatusOutput: {} + waf_ip_set_cache_ValidateCreateDataOutput: + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/WafIPSetCacheDetails' + type: object + waf_ip_set_cache_ValidateUpdateDataOutput: + schema: + properties: + waf_ip_set_cache: + $ref: '#/definitions/WafIPSetCacheDetails' + type: object + waf_regex_set_CustomizeDeleteOutput: + schema: + properties: + waf_regex_set: + $ref: '#/definitions/WafRegexSetDetails' + type: object + waf_regex_set_FetchCustomizeColumnsOutput: + schema: + properties: + waf_regex_set: + $ref: '#/definitions/WafRegexSetDetails' + type: object + waf_regex_set_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + waf_regex_set: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + waf_regex_set_GetDetailsClassMetadataOutput: + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_GetDetailsMetadataOutput: + schema: + properties: + waf_regex_set: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_GetDetailsStatusOutput: + schema: + properties: + waf_regex_set: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_regex_set_GetPropertyDistinctFieldOutput: {} + waf_regex_set_GetPropertyDomainTagValuePairsOutput: {} + waf_regex_set_GetPropertyDomainTagValueTreeOutput: {} + waf_regex_set_GetPropertySplitableExportOutput: {} + waf_regex_set_GetPropertySplitableOutput: {} + waf_regex_set_GetPropertyStatisticsOutput: + schema: + properties: + waf_regex_set: + $ref: '#/definitions/StatusStatistic' + type: object + waf_regex_set_GetPropertyTagValuePairsOutput: {} + waf_regex_set_GetPropertyTagValueTreeOutput: {} + waf_regex_set_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_regex_sets: + items: + $ref: '#/definitions/WafRegexSetDetails' + type: array + x-go-name: Output + type: object + waf_regex_set_PerformChangeOwnerOutput: {} + waf_regex_set_PerformClassMetadataOutput: {} + waf_regex_set_PerformPrivateOutput: {} + waf_regex_set_PerformPublicOutput: {} + waf_regex_set_PerformPurgeSplitableOutput: {} + waf_regex_set_PerformSetClassMetadataOutput: {} + waf_regex_set_PerformSetUserMetadataOutput: {} + waf_regex_set_PerformStatusOutput: {} + waf_regex_set_ValidateCreateDataOutput: + schema: + properties: + waf_regex_set: + $ref: '#/definitions/WafRegexSetDetails' + type: object + waf_regex_set_ValidateUpdateDataOutput: + schema: + properties: + waf_regex_set: + $ref: '#/definitions/WafRegexSetDetails' + type: object + waf_regex_set_cache_CustomizeDeleteOutput: + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: object + waf_regex_set_cache_FetchCustomizeColumnsOutput: + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: object + waf_regex_set_cache_GetDetailsClassMetadataOutput: + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_cache_GetDetailsMetadataOutput: + schema: + properties: + waf_regex_set_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_regex_set_cache_GetDetailsStatusOutput: + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_regex_set_cache_GetPropertyDistinctFieldOutput: {} + waf_regex_set_cache_GetPropertySplitableExportOutput: {} + waf_regex_set_cache_GetPropertySplitableOutput: {} + waf_regex_set_cache_GetPropertyStatisticsOutput: + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/StatusStatistic' + type: object + waf_regex_set_cache_GetPropertyTagValuePairsOutput: {} + waf_regex_set_cache_GetPropertyTagValueTreeOutput: {} + waf_regex_set_cache_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_regex_set_caches: + items: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: array + x-go-name: Output + type: object + waf_regex_set_cache_PerformClassMetadataOutput: {} + waf_regex_set_cache_PerformPurgeSplitableOutput: {} + waf_regex_set_cache_PerformSetClassMetadataOutput: {} + waf_regex_set_cache_PerformSetUserMetadataOutput: {} + waf_regex_set_cache_PerformStatusOutput: {} + waf_regex_set_cache_ValidateCreateDataOutput: + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: object + waf_regex_set_cache_ValidateUpdateDataOutput: + schema: + properties: + waf_regex_set_cache: + $ref: '#/definitions/WafRegexSetCacheDetails' + type: object + waf_rule_CustomizeDeleteOutput: + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleDetails' + type: object + waf_rule_FetchCustomizeColumnsOutput: + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleDetails' + type: object + waf_rule_GetDetailsClassMetadataOutput: + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_GetDetailsMetadataOutput: + schema: + properties: + waf_rule: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_GetDetailsStatusOutput: + schema: + properties: + waf_rule: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_rule_GetPropertyDistinctFieldOutput: {} + waf_rule_GetPropertySplitableExportOutput: {} + waf_rule_GetPropertySplitableOutput: {} + waf_rule_GetPropertyStatisticsOutput: + schema: + properties: + waf_rule: + $ref: '#/definitions/StatusStatistic' + type: object + waf_rule_GetPropertyTagValuePairsOutput: {} + waf_rule_GetPropertyTagValueTreeOutput: {} + waf_rule_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_rules: + items: + $ref: '#/definitions/WafRuleDetails' + type: array + x-go-name: Output + type: object + waf_rule_PerformClassMetadataOutput: {} + waf_rule_PerformPurgeSplitableOutput: {} + waf_rule_PerformSetClassMetadataOutput: {} + waf_rule_PerformSetUserMetadataOutput: {} + waf_rule_PerformStatusOutput: {} + waf_rule_PerformSyncstatusOutput: {} + waf_rule_ValidateCreateDataOutput: + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleDetails' + type: object + waf_rule_ValidateUpdateDataOutput: + schema: + properties: + waf_rule: + $ref: '#/definitions/WafRuleDetails' + type: object + waf_rule_group_CustomizeDeleteOutput: + schema: + properties: + waf_rule_group: + $ref: '#/definitions/WafRuleGroupDetails' + type: object + waf_rule_group_FetchCustomizeColumnsOutput: + schema: + properties: + waf_rule_group: + $ref: '#/definitions/WafRuleGroupDetails' + type: object + waf_rule_group_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + waf_rule_group: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + waf_rule_group_GetDetailsClassMetadataOutput: + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_GetDetailsMetadataOutput: + schema: + properties: + waf_rule_group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_GetDetailsStatusOutput: + schema: + properties: + waf_rule_group: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_rule_group_GetPropertyDistinctFieldOutput: {} + waf_rule_group_GetPropertyDomainTagValuePairsOutput: {} + waf_rule_group_GetPropertyDomainTagValueTreeOutput: {} + waf_rule_group_GetPropertySplitableExportOutput: {} + waf_rule_group_GetPropertySplitableOutput: {} + waf_rule_group_GetPropertyStatisticsOutput: + schema: + properties: + waf_rule_group: + $ref: '#/definitions/StatusStatistic' + type: object + waf_rule_group_GetPropertyTagValuePairsOutput: {} + waf_rule_group_GetPropertyTagValueTreeOutput: {} + waf_rule_group_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_rule_groups: + items: + $ref: '#/definitions/WafRuleGroupDetails' + type: array + x-go-name: Output + type: object + waf_rule_group_PerformChangeOwnerOutput: {} + waf_rule_group_PerformClassMetadataOutput: {} + waf_rule_group_PerformPrivateOutput: {} + waf_rule_group_PerformPublicOutput: {} + waf_rule_group_PerformPurgeSplitableOutput: {} + waf_rule_group_PerformSetClassMetadataOutput: {} + waf_rule_group_PerformSetUserMetadataOutput: {} + waf_rule_group_PerformStatusOutput: {} + waf_rule_group_ValidateCreateDataOutput: + schema: + properties: + waf_rule_group: + $ref: '#/definitions/WafRuleGroupDetails' + type: object + waf_rule_group_ValidateUpdateDataOutput: + schema: + properties: + waf_rule_group: + $ref: '#/definitions/WafRuleGroupDetails' + type: object + waf_rule_group_cache_CustomizeDeleteOutput: + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: object + waf_rule_group_cache_FetchCustomizeColumnsOutput: + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: object + waf_rule_group_cache_GetDetailsClassMetadataOutput: + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_cache_GetDetailsMetadataOutput: + schema: + properties: + waf_rule_group_cache: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + waf_rule_group_cache_GetDetailsStatusOutput: + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + waf_rule_group_cache_GetPropertyDistinctFieldOutput: {} + waf_rule_group_cache_GetPropertySplitableExportOutput: {} + waf_rule_group_cache_GetPropertySplitableOutput: {} + waf_rule_group_cache_GetPropertyStatisticsOutput: + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/StatusStatistic' + type: object + waf_rule_group_cache_GetPropertyTagValuePairsOutput: {} + waf_rule_group_cache_GetPropertyTagValueTreeOutput: {} + waf_rule_group_cache_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_rule_group_caches: + items: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: array + x-go-name: Output + type: object + waf_rule_group_cache_PerformClassMetadataOutput: {} + waf_rule_group_cache_PerformPurgeSplitableOutput: {} + waf_rule_group_cache_PerformSetClassMetadataOutput: {} + waf_rule_group_cache_PerformSetUserMetadataOutput: {} + waf_rule_group_cache_PerformStatusOutput: {} + waf_rule_group_cache_ValidateCreateDataOutput: + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: object + waf_rule_group_cache_ValidateUpdateDataOutput: + schema: + properties: + waf_rule_group_cache: + $ref: '#/definitions/WafRuleGroupCacheDetails' + type: object + waf_rule_statement_CustomizeDeleteOutput: + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseDetails' + type: object + waf_rule_statement_FetchCustomizeColumnsOutput: + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseDetails' + type: object + waf_rule_statement_GetPropertyDistinctFieldOutput: {} + waf_rule_statement_GetPropertySplitableExportOutput: {} + waf_rule_statement_GetPropertySplitableOutput: {} + waf_rule_statement_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + waf_rule_statements: + items: + $ref: '#/definitions/ResourceBaseDetails' + type: array + x-go-name: Output + type: object + waf_rule_statement_PerformPurgeSplitableOutput: {} + waf_rule_statement_ValidateCreateDataOutput: + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseDetails' + type: object + waf_rule_statement_ValidateUpdateDataOutput: + schema: + properties: + waf_rule_statement: + $ref: '#/definitions/ResourceBaseDetails' + type: object + wire_CustomizeDeleteOutput: + schema: + properties: + wire: + $ref: '#/definitions/WireDetails' + type: object + wire_FetchCustomizeColumnsOutput: + schema: + properties: + wire: + $ref: '#/definitions/WireDetails' + type: object + wire_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + wire: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + wire_GetDetailsClassMetadataOutput: + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + wire_GetDetailsMetadataOutput: + schema: + properties: + wire: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + wire_GetDetailsStatusOutput: + schema: + properties: + wire: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + wire_GetDetailsTopologyOutput: + schema: + properties: + wire: + $ref: '#/definitions/WireTopologyOutput' + type: object + wire_GetPropertyDistinctFieldOutput: {} + wire_GetPropertyDomainTagValuePairsOutput: {} + wire_GetPropertyDomainTagValueTreeOutput: {} + wire_GetPropertySplitableExportOutput: {} + wire_GetPropertySplitableOutput: {} + wire_GetPropertyStatisticsOutput: + schema: + properties: + wire: + $ref: '#/definitions/StatusStatistic' + type: object + wire_GetPropertyTagValuePairsOutput: {} + wire_GetPropertyTagValueTreeOutput: {} + wire_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + wires: + items: + $ref: '#/definitions/WireDetails' + type: array + x-go-name: Output + type: object + wire_PerformChangeOwnerOutput: {} + wire_PerformClassMetadataOutput: {} + wire_PerformMergeFromOutput: {} + wire_PerformMergeNetworkOutput: {} + wire_PerformMergeToOutput: {} + wire_PerformPrivateOutput: {} + wire_PerformPublicOutput: {} + wire_PerformPurgeSplitableOutput: {} + wire_PerformSetClassMetadataOutput: {} + wire_PerformSetUserMetadataOutput: {} + wire_PerformStatusOutput: {} + wire_ValidateCreateDataOutput: + schema: + properties: + wire: + $ref: '#/definitions/WireDetails' + type: object + wire_ValidateUpdateDataOutput: + schema: + properties: + wire: + $ref: '#/definitions/WireDetails' + type: object + zone_CustomizeDeleteOutput: + schema: + properties: + zone: + $ref: '#/definitions/ZoneDetails' + type: object + zone_FetchCustomizeColumnsOutput: + schema: + properties: + zone: + $ref: '#/definitions/ZoneDetails' + type: object + zone_GetDetailsCapabilityOutput: {} + zone_GetDetailsClassMetadataOutput: + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + zone_GetDetailsDiskCapabilityOutput: {} + zone_GetDetailsMetadataOutput: + schema: + properties: + zone: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + zone_GetDetailsStatusOutput: + schema: + properties: + zone: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + zone_GetPropertyDistinctFieldOutput: {} + zone_GetPropertySplitableExportOutput: {} + zone_GetPropertySplitableOutput: {} + zone_GetPropertyStatisticsOutput: + schema: + properties: + zone: + $ref: '#/definitions/StatusStatistic' + type: object + zone_GetPropertyTagValuePairsOutput: {} + zone_GetPropertyTagValueTreeOutput: {} + zone_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + zones: + items: + $ref: '#/definitions/ZoneDetails' + type: array + x-go-name: Output + type: object + zone_PerformClassMetadataOutput: {} + zone_PerformPurgeSplitableOutput: {} + zone_PerformSetClassMetadataOutput: {} + zone_PerformSetSchedtagOutput: {} + zone_PerformSetUserMetadataOutput: {} + zone_PerformStatusOutput: {} + zone_ValidateCreateDataOutput: + schema: + properties: + zone: + $ref: '#/definitions/ZoneDetails' + type: object + zone_ValidateUpdateDataOutput: + schema: + properties: + zone: + $ref: '#/definitions/ZoneDetails' + type: object +schemes: +- https +- http +securityDefinitions: + keystone: + in: header + name: X-Auth-Token + type: apiKey +swagger: "2.0" diff --git a/docs/swagger/swagger_identity.yaml b/docs/swagger/swagger_identity.yaml new file mode 100644 index 0000000000..55bbec5ecd --- /dev/null +++ b/docs/swagger/swagger_identity.yaml @@ -0,0 +1,12691 @@ +basePath: / +consumes: +- application/json +definitions: + CredentialCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + blob: + type: string + x-go-name: Blob + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypted_blob: + description: Ignore + type: string + x-go-name: EncryptedBlob + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + key_hash: + description: Ignore + type: string + x-go-name: KeyHash + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_id: + type: string + x-go-name: ProjectId + type: + type: string + x-go-name: Type + user_id: + type: string + x-go-name: UserId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + CredentialDetails: + properties: + blob: + type: string + x-go-name: Blob + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + enabled: + type: boolean + x-go-name: Enabled + encrypted_blob: + type: string + x-go-name: EncryptedBlob + extra: + type: object + x-go-name: Extra + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + key_hash: + type: string + x-go-name: KeyHash + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + project_id: + type: string + x-go-name: ProjectId + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + user: + type: string + x-go-name: User + user_id: + type: string + x-go-name: UserId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + CredentialUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: enabled + type: boolean + x-go-name: Enabled + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + DomainCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + displayname: + description: 显示名 + type: string + x-go-name: Displayname + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 是否启用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + DomainDetails: + properties: + admin_id: + type: string + x-go-name: AdminId + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + type: string + x-go-name: DomainId + enabled: + description: 改域是否启用 + type: boolean + x-go-name: Enabled + ext_resource: + additionalProperties: + format: int64 + type: integer + description: 外部资源统计信息（资源类别：数量） + type: object + x-go-name: ExtResource + ext_resources_last_update: + description: 外部资源统计信息上次更新时间 + format: date-time + type: string + x-go-name: ExtResourcesLastUpdate + ext_resources_next_update: + description: 外部资源统计信息下次更新时间 + format: date-time + type: string + x-go-name: ExtResourcesNextUpdate + extra: + description: 额外信息 + type: object + x-go-name: Extra + group_count: + description: 归属域的用户组数量 + format: int64 + type: integer + x-go-name: GroupCount + id: + description: 资源UUID + type: string + x-go-name: Id + idp: + description: 认证源名称 + type: string + x-go-name: Idp + idp_count: + description: 归属域的认证源数量 + format: int64 + type: integer + x-go-name: IdpCount + idp_driver: + description: 认证源类型, 例如sql, cas, ldap等 + type: string + x-go-name: IdpDriver + idp_entity_id: + description: 该资源在认证源的原始ID + type: string + x-go-name: IdpEntityId + idp_id: + description: 认证源ID + type: string + x-go-name: IdpId + is_domain: + description: 是否为域 + type: boolean + x-go-name: IsDomain + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + parent_id: + type: string + x-go-name: ParentId + policy_count: + description: 归属域的权限策略数量 + format: int64 + type: integer + x-go-name: PolicyCount + project_count: + description: 归属域的项目数量 + format: int64 + type: integer + x-go-name: ProjectCount + role_count: + description: 归属域的角色数量 + format: int64 + type: integer + x-go-name: RoleCount + template: + description: 认证源模板 + type: string + x-go-name: Template + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + user_count: + description: 归属域的用户数量 + format: int64 + type: integer + x-go-name: UserCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + DomainUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + displayname: + description: 显示名 + type: string + x-go-name: Displayname + enabled: + description: 是否启用 + type: boolean + x-go-name: Enabled + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + EndpointDetails: + properties: + ca_certificate: + type: string + x-go-name: CaCertificate + ca_private_key: + type: string + x-go-name: CaPrivateKey + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cert_id: + type: string + x-go-name: CertId + cert_name: + type: string + x-go-name: CertName + certificate: + type: string + x-go-name: Certificate + common_name: + type: string + x-go-name: CommonName + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + enabled: + type: boolean + x-go-name: Enabled + extra: + type: object + x-go-name: Extra + fingerprint: + type: string + x-go-name: Fingerprint + id: + description: 资源UUID + type: string + x-go-name: Id + interface: + type: string + x-go-name: Interface + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + legacy_endpoint_id: + type: string + x-go-name: LegacyEndpointId + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + not_after: + format: date-time + type: string + x-go-name: NotAfter + not_before: + format: date-time + type: string + x-go-name: NotBefore + private_key: + type: string + x-go-name: PrivateKey + public_key_algorithm: + description: derived attributes + type: string + x-go-name: PublicKeyAlgorithm + public_key_bit_len: + format: int64 + type: integer + x-go-name: PublicKeyBitLen + region_id: + type: string + x-go-name: RegionId + service_certificate_id: + type: string + x-go-name: ServiceCertificateId + service_id: + type: string + x-go-name: ServiceId + service_name: + description: 服务名称,例如keystone, glance, region等 + type: string + x-go-name: ServiceName + service_type: + description: 服务类型,例如identity, image, compute等 + type: string + x-go-name: ServiceType + signature_algorithm: + type: string + x-go-name: SignatureAlgorithm + subject_alternative_names: + type: string + x-go-name: SubjectAlternativeNames + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + url: + type: string + x-go-name: Url + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + GetIdpSamlMetadataOutput: + properties: + metadata: + description: SAML 2.0 SP metadata + type: string + x-go-name: Metadata + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + GetIdpSsoCallbackUriOutput: + properties: + driver: + description: Driver + type: string + x-go-name: Driver + redirect_uri: + description: SSO回调地址 + type: string + x-go-name: RedirectUri + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + GetIdpSsoRedirectUriOutput: + properties: + driver: + description: Driver + type: string + x-go-name: Driver + uri: + description: SSO跳转URI + type: string + x-go-name: Uri + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + GroupCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + displayname: + description: display name + type: string + x-go-name: Displayname + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + GroupDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + displayname: + description: 用户组的显示名称 + type: string + x-go-name: Displayname + domain_id: + description: 域Id + type: string + x-go-name: DomainId + extra: + description: 额外信息 + type: object + x-go-name: Extra + id: + description: 资源UUID + type: string + x-go-name: Id + idp: + description: 认证源名称 + type: string + x-go-name: Idp + idp_driver: + description: 认证源类型, 例如sql, cas, ldap等 + type: string + x-go-name: IdpDriver + idp_entity_id: + description: 该资源在认证源的原始ID + type: string + x-go-name: IdpEntityId + idp_id: + description: 认证源ID + type: string + x-go-name: IdpId + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + project_count: + description: 项目数量 + format: int64 + type: integer + x-go-name: ProjectCount + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + template: + description: 认证源模板 + type: string + x-go-name: Template + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + user_count: + description: 用户数量 + format: int64 + type: integer + x-go-name: UserCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + GroupUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + displayname: + description: display name + type: string + x-go-name: Displayname + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + IdentityProviderCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + auto_create_project: + description: 新建域的时候是否自动新建第一个项目 + type: boolean + x-go-name: AutoCreateProject + auto_create_user: + description: 当用户不存在时，是否自动新建用户 + type: boolean + x-go-name: AutoCreateUser + config: + $ref: '#/definitions/TConfigs' + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + driver: + description: 后端驱动名称 + type: string + x-go-name: Driver + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + icon_uri: + description: 图标URL + type: string + x-go-name: IconUri + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + owner_domain_id: + description: 归属域 + type: string + x-go-name: OwnerDomainId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + sync_interval_seconds: + description: 自动同步间隔，单位：秒 + format: int64 + type: integer + x-go-name: SyncIntervalSeconds + target_domain_id: + description: 默认导入用户和组的域 + type: string + x-go-name: TargetDomainId + template: + description: 模板名称 + type: string + x-go-name: Template + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + IdentityProviderDetails: + properties: + auto_create_project: + description: 是否自动创建项目 + type: boolean + x-go-name: AutoCreateProject + auto_create_user: + description: 是否自动创建用户 + type: boolean + x-go-name: AutoCreateUser + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_count: + description: 该认证源关联的所有域的数量 + format: int64 + type: integer + x-go-name: DomainCount + domain_id: + description: 域Id + type: string + x-go-name: DomainId + driver: + type: string + x-go-name: Driver + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + error_count: + format: int64 + type: integer + x-go-name: ErrorCount + group_count: + description: 该认证源关联的所有域的组数量 + format: int64 + type: integer + x-go-name: GroupCount + icon_uri: + description: 认证源图标 + type: string + x-go-name: IconUri + id: + description: 资源UUID + type: string + x-go-name: Id + is_default: + description: 是否是缺省SSO登录方式 + type: boolean + x-go-name: IsDefault + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_sso: + description: 是否是SSO登录方式 + type: boolean + x-go-name: IsSso + last_sync: + format: date-time + type: string + x-go-name: LastSync + last_sync_end_at: + description: = Column(DateTime, nullable=True) + format: date-time + type: string + x-go-name: LastSyncEndAt + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + policy_count: + description: 该认证源关联的所有域的权限策略数量 + format: int64 + type: integer + x-go-name: PolicyCount + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_count: + description: 该认证源关联的所有域的项目数量 + format: int64 + type: integer + x-go-name: ProjectCount + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + role_count: + description: 该认证源关联的所有域的角色数量 + format: int64 + type: integer + x-go-name: RoleCount + status: + description: 资源状态 + type: string + x-go-name: Status + sync_interval_seconds: + description: 认证源账号信息同步周期 + format: int64 + type: integer + x-go-name: SyncIntervalSeconds + sync_status: + type: string + x-go-name: SyncStatus + target_domain: + description: 认证源的目标域名称 + type: string + x-go-name: TargetDomain + target_domain_id: + type: string + x-go-name: TargetDomainId + template: + type: string + x-go-name: Template + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + user_count: + description: 该认证源关联的所有域的用户数量 + format: int64 + type: integer + x-go-name: UserCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + IdentityProviderUpdateInput: + properties: + auto_create_project: + description: 当认证后用户加入项目不存在时是否自动创建项目 + type: boolean + x-go-name: AutoCreateProject + auto_create_user: + description: 当认证后用户不存在时是否自动创建用户 + type: boolean + x-go-name: AutoCreateUser + description: + description: 资源描述 + type: string + x-go-name: Description + icon_uri: + description: 图标URL + type: string + x-go-name: IconUri + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + sync_interval_seconds: + format: int64 + type: integer + x-go-name: SyncIntervalSeconds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + IdpResourceInfo: + properties: + idp: + description: 认证源名称 + type: string + x-go-name: Idp + idp_driver: + description: 认证源类型, 例如sql, cas, ldap等 + type: string + x-go-name: IdpDriver + idp_entity_id: + description: 该资源在认证源的原始ID + type: string + x-go-name: IdpEntityId + idp_id: + description: 认证源ID + type: string + x-go-name: IdpId + template: + description: 认证源模板 + type: string + x-go-name: Template + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + KeystoneDomainV3: + $ref: '#/definitions/SIdentityObject' + KeystoneEndpointV2: + properties: + admin_url: + description: 管理URL + type: string + x-go-name: AdminURL + id: + description: 接口ID + type: string + x-go-name: Id + internal_url: + description: 内部URL + type: string + x-go-name: InternalURL + public_url: + description: 外部URL + type: string + x-go-name: PublicURL + region: + description: 区域ID + type: string + x-go-name: Region + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneEndpointV3: + properties: + id: + description: endpoint ID + example: 75f4e36100184a5a8a3e36cb0f12aa87 + type: string + x-go-name: Id + interface: + description: |- + endpoint接口类型，目前定义了一下集中类型 + + interface | 说明 | + -----------|--------------------------------------------------------| + internal | 内部接口，访问服务时默认用inernal类型的接口 | + public | 外部接口 | + admin | 管理类型接口，deprecated | + console | web控制台接口，指定显示在web控制台的外部服务的接口地址 | + type: string + x-go-name: Interface + name: + description: 接口名称 + type: string + x-go-name: Name + region: + description: 区域名称 + type: string + x-go-name: Region + region_id: + description: 区域ID + type: string + x-go-name: RegionId + url: + description: 接口URL + type: string + x-go-name: Url + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneMetadataV2: + properties: + is_admin: + description: 是否为管理员 + format: int64 + type: integer + x-go-name: IsAdmin + roles: + description: 角色 + items: + type: string + type: array + x-go-name: Roles + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystonePolicy: + properties: + Domain: + description: 域范围的权限 + items: + type: string + type: array + Project: + description: 项目范围的权限 + items: + type: string + type: array + System: + description: 系统范围的权限 + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneProjectV3: + properties: + Domain: + $ref: '#/definitions/KeystoneDomainV3' + Id: + description: 项目ID + type: string + Name: + description: 项目名称 + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneRoleV2: + properties: + id: + description: 角色ID + type: string + x-go-name: Id + name: + description: 角色名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneRoleV3: + $ref: '#/definitions/SIdentityObject' + KeystoneServiceCatalogV2: + items: + $ref: '#/definitions/KeystoneServiceV2' + type: array + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneServiceCatalogV3: + items: + $ref: '#/definitions/KeystoneServiceV3' + type: array + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneServiceV2: + properties: + endpoints: + description: 服务接口地址列表 + items: + $ref: '#/definitions/KeystoneEndpointV2' + type: array + x-go-name: Endpoints + name: + description: 服务名称 + type: string + x-go-name: Name + type: + description: 服务类型 + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneServiceV3: + properties: + endpoints: + description: service的访问endpoints + items: + $ref: '#/definitions/KeystoneEndpointV3' + type: array + x-go-name: Endpoints + id: + description: service ID + type: string + x-go-name: Id + name: + description: service Name + type: string + x-go-name: Name + type: + description: service Type，例如identity, compute等 + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneTenantV2: + properties: + description: + description: 描述 + type: string + x-go-name: Description + domain: + description: 项目归属域信息 + properties: + id: + description: 域ID + type: string + x-go-name: Id + name: + description: 域名称 + type: string + x-go-name: Name + type: object + x-go-name: Domain + enabled: + description: 是否启用 + type: boolean + x-go-name: Enabled + id: + description: 项目ID + type: string + x-go-name: Id + name: + description: 项目名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneTokenV2: + properties: + expires: + description: 过期时间(UTC) + format: date-time + type: string + x-go-name: Expires + id: + description: token + type: string + x-go-name: Id + tenant: + $ref: '#/definitions/KeystoneTenantV2' + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneTokenV3: + properties: + access_key: + $ref: '#/definitions/SAccessKeySecretInfo' + catalog: + $ref: '#/definitions/KeystoneServiceCatalogV3' + context: + $ref: '#/definitions/SAuthContext' + expires_at: + description: token过期时间 + format: date-time + type: string + x-go-name: ExpiresAt + is_domain: + description: 是否为域的token + type: boolean + x-go-name: IsDomain + issued_at: + description: token颁发时间 + format: date-time + type: string + x-go-name: IssuedAt + methods: + description: 获取token的认证方式 + items: + type: string + type: array + x-go-name: Methods + policies: + $ref: '#/definitions/KeystonePolicy' + project: + $ref: '#/definitions/KeystoneProjectV3' + projects: + description: 当用户认证时未指定scope时，会返回该用户所有的项目 + items: + $ref: '#/definitions/KeystoneProjectV3' + type: array + x-go-name: Projects + role_assignments: + description: 返回用户在所有项目的所有角色信息 + items: + $ref: '#/definitions/SRoleAssignment' + type: array + x-go-name: RoleAssignments + roles: + description: token的关联用户在关联项目的角色列表，只有项目scope的token才有这个属性 + items: + $ref: '#/definitions/KeystoneRoleV3' + type: array + x-go-name: Roles + user: + $ref: '#/definitions/KeystoneUserV3' + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneUserV2: + properties: + id: + description: 用户ID + type: string + x-go-name: Id + name: + description: 用户名 + type: string + x-go-name: Name + roles: + description: 用户角色列表 + items: + $ref: '#/definitions/KeystoneRoleV2' + type: array + x-go-name: Roles + username: + description: 用户username + type: string + x-go-name: Username + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + KeystoneUserV3: + properties: + Displayname: + description: 用户的显式名称，通常为中文名 + type: string + Domain: + $ref: '#/definitions/KeystoneDomainV3' + Email: + description: 用户Email + type: string + Id: + description: 用户ID + type: string + Mobile: + description: 用户手机号 + type: string + Name: + description: 用户名称 + type: string + PasswordExpiresAt: + description: 用户密码过期时间 + format: date-time + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + ModelBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ModelBaseDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ModelBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformConfigInput: + properties: + action: + description: 更新配置的方式 + example: update + type: string + x-go-name: Action + config: + $ref: '#/definitions/TConfigs' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PerformDefaultSsoInput: + properties: + enable: + type: boolean + x-go-name: Enable + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformGroupAddUsersInput: + properties: + user_ids: + description: 待添加用户列表（ID或名称） + items: + type: string + type: array + x-go-name: UserIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PerformGroupRemoveUsersInput: + properties: + user_ids: + description: 待删除用户列表（ID或名称） + items: + type: string + type: array + x-go-name: UserIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicDomainInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PolicyBindRoleInput: + properties: + ips: + description: IP白名单 + items: + type: string + type: array + x-go-name: Ips + project_id: + description: 项目ID + type: string + x-go-name: ProjectId + role_id: + description: 角色ID + type: string + x-go-name: RoleId + valid_since: + description: 权限有效开始时间 + format: date-time + type: string + x-go-name: ValidSince + valid_until: + description: 权限有效结束时间 + format: date-time + type: string + x-go-name: ValidUntil + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PolicyCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + blob: + description: policy + type: object + x-go-name: Blob + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + domain_tags: + $ref: '#/definitions/TTagSet' + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否为系统权限 + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_tags: + $ref: '#/definitions/TTagSet' + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + resource_tags: + $ref: '#/definitions/TTagSet' + scope: + $ref: '#/definitions/TRbacScope' + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PolicyDetails: + properties: + blob: + description: 权限定义 + type: object + x-go-name: Blob + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_tags: + description: 匹配的域标签 + items: + $ref: '#/definitions/STag' + type: array + x-go-name: DomainTags + enabled: + type: boolean + x-go-name: Enabled + extra: + description: 额外信息 + type: object + x-go-name: Extra + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否为系统权限 + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + object_tags: + description: 匹配的资源标签 + items: + $ref: '#/definitions/STag' + type: array + x-go-name: ObjectTags + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_tags: + description: 匹配的项目标签 + items: + $ref: '#/definitions/STag' + type: array + x-go-name: ProjectTags + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + scope: + description: 权限范围 + type: string + x-go-name: Scope + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PolicyUpdateInput: + properties: + blob: + description: Policy内容 + type: object + x-go-name: Blob + description: + description: 资源描述 + type: string + x-go-name: Description + domain_tags: + $ref: '#/definitions/TTagSet' + enabled: + description: 是否启用 + type: boolean + x-go-name: Enabled + is_system: + description: 是否为系统权限 + type: boolean + x-go-name: IsSystem + name: + description: 资源名称 + type: string + x-go-name: Name + object_tags: + $ref: '#/definitions/TTagSet' + project_tags: + $ref: '#/definitions/TTagSet' + scope: + $ref: '#/definitions/TRbacScope' + tag_update_policy: + description: Policy tag更新策略，可能的值为：add|remove|remove，默认为add + type: string + x-go-name: TagUpdatePolicy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + ProjectCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + displayname: + description: 显示名称 + type: string + x-go-name: Displayname + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + ProjectDetails: + properties: + admin: + description: 项目管理员名称 + type: string + x-go-name: Admin + admin_domain: + description: 项目管理员域名称 + type: string + x-go-name: AdminDomain + admin_domain_id: + description: 项目管理员域ID + type: string + x-go-name: AdminDomainId + admin_id: + type: string + x-go-name: AdminId + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + ext_resource: + additionalProperties: + format: int64 + type: integer + description: 外部资源统计信息（资源类别：数量） + type: object + x-go-name: ExtResource + ext_resources_last_update: + description: 外部资源统计信息上次更新时间 + format: date-time + type: string + x-go-name: ExtResourcesLastUpdate + ext_resources_next_update: + description: 外部资源统计信息下次更新时间 + format: date-time + type: string + x-go-name: ExtResourcesNextUpdate + extra: + description: 额外信息 + type: object + x-go-name: Extra + group_count: + description: 加入项目的用户组数量 + format: int64 + type: integer + x-go-name: GroupCount + id: + description: 资源UUID + type: string + x-go-name: Id + is_domain: + description: 该项目是否为域（domain） + type: boolean + x-go-name: IsDomain + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + parent_id: + description: 上级项目或域的ID + type: string + x-go-name: ParentId + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + user_count: + description: 加入项目的用户数量 + format: int64 + type: integer + x-go-name: UserCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + ProjectUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + displayname: + description: 显示名称 + type: string + x-go-name: Displayname + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + RegionDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + endpoint_count: + format: int64 + type: integer + x-go-name: EndpointCount + extra: + type: object + x-go-name: Extra + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + parent_region_id: + type: string + x-go-name: ParentRegionId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + ResetCredentialInput: + properties: + type: + description: 密钥的类型 + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + ResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + RoleCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + RoleDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + extra: + description: 额外信息 + type: object + x-go-name: Extra + group_count: + description: 具有该角色的用户组数量 + format: int64 + type: integer + x-go-name: GroupCount + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + match_policies: + description: 该角色匹配的权限的名称列表 + items: + type: string + type: array + x-go-name: MatchPolicies + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + policies: + additionalProperties: + items: + type: string + type: array + description: 不同级别的权限的名称列表 + type: object + x-go-name: Policies + project_count: + description: 有该角色的用户或组的项目的数量 + format: int64 + type: integer + x-go-name: ProjectCount + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + user_count: + description: 具有该角色的用户数量 + format: int64 + type: integer + x-go-name: UserCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + RolePerformAddPolicyInput: + properties: + ips: + items: + type: string + type: array + x-go-name: Ips + policy_id: + type: string + x-go-name: PolicyId + project_id: + type: string + x-go-name: ProjectId + valid_since: + format: date-time + type: string + x-go-name: ValidSince + valid_until: + format: date-time + type: string + x-go-name: ValidUntil + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + RolePerformRemovePolicyInput: + properties: + policy_id: + type: string + x-go-name: PolicyId + project_id: + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + RolePerformSetPoliciesInput: + properties: + action: + description: 操作：replace|update, 默认为replace + type: string + x-go-name: Action + policies: + description: 权限列表 + items: + $ref: '#/definitions/RolePerformAddPolicyInput' + type: array + x-go-name: Policies + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + RolePolicyDetails: + properties: + auth: + description: 是否需要认证 + type: boolean + x-go-name: Auth + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + type: string + x-go-name: Description + id: + type: string + x-go-name: Id + ips: + description: 匹配的IP白名单 + type: string + x-go-name: Ips + name: + type: string + x-go-name: Name + policy: + type: string + x-go-name: Policy + policy_id: + description: 权限ID, 主键 + type: string + x-go-name: PolicyId + project: + type: string + x-go-name: Project + project_id: + description: 项目ID，主键 + type: string + x-go-name: ProjectId + role: + type: string + x-go-name: Role + role_id: + description: 角色ID, 主键 + type: string + x-go-name: RoleId + scope: + $ref: '#/definitions/TRbacScope' + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + valid_since: + description: 匹配开始时间 + format: date-time + type: string + x-go-name: ValidSince + valid_until: + description: 匹配结束时间 + format: date-time + type: string + x-go-name: ValidUntil + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + RoleUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SAccessKeySecretInfo: + properties: + AccessKey: + type: string + expire: + format: int64 + type: integer + x-go-name: Expire + secret: + type: string + x-go-name: Secret + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SAuthContext: + properties: + ip: + description: 认证来源IP + type: string + x-go-name: Ip + source: + description: |- + 认证来源类型, 可能的值有： + + source | 说明 | + ----------|---------------------------| + web | 通过web控制台认证 | + api | api调用认证 | + cli | climc客户端认证 | + srv | 作为服务认证 | + operator | 作为onecloud-operator认证 | + type: string + x-go-name: Source + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + SAuthenticateV2ResponseBody: + properties: + access: + $ref: '#/definitions/TokenCredentialV2' + type: object + x-go-package: yunion.io/x/onecloud/pkg/keystone/tokens + SAuthenticationIdentity: + properties: + access_key_secret: + description: |- + 当认证方式为aksk时，通过该字段提供客户端AK/SK信息 + 为了兼容不同版本的AK/SK认证方式，使用编码后的字符串传递该信息 + type: string + x-go-name: AccessKeyRequest + cas_ticket: + description: 当认证方式为cas时，通过该字段提供CAS认证的ID + properties: + id: + type: string + x-go-name: Id + service: + type: string + x-go-name: Service + type: object + x-go-name: CASTicket + id: + description: ID of identity provider, optional + type: string + x-go-name: Id + methods: + description: |- + 认证方式列表，支持认证方式如下： + + method | 说明 | + ----------|--------------------------------------------------------------------| + password | 用户名密码认证 | + token | token认证，已经通过其他方式获得token之后，可以用旧的token认证获得新的token | + aksk | Access Key/Secret key认证 | + cas | 通过SSO统一认证平台CAS认证 | + saml | 作为SAML 2.0 SP通过IDP认证 | + oidc | 作为OpenID Connect/OAuth2 Client认证 | + oauth2 | OAuth2认证 | + verify | 手机短信或邮箱认证 | + items: + type: string + type: array + x-go-name: Methods + mobile: + properties: + contact_type: + type: string + x-go-name: ContactType + uid: + type: string + x-go-name: Uid + verify_code: + type: string + x-go-name: VerifyCode + type: object + x-go-name: Verify + oauth2: + properties: + code: + type: string + x-go-name: Code + type: object + x-go-name: OAuth2 + oidc_auth: + properties: + code: + type: string + x-go-name: Code + redirect_uri: + type: string + x-go-name: RedirectUri + type: object + x-go-name: OIDCAuth + password: + description: 当认证方式为password时，通过该字段提供密码认证信息 + properties: + user: + properties: + Domain: + description: 用户所属域的信息 + properties: + id: + description: 域ID + type: string + x-go-name: Id + name: + description: 域名称 + type: string + x-go-name: Name + type: object + id: + description: 用户ID + type: string + x-go-name: Id + name: + description: 用户名称 + type: string + x-go-name: Name + password: + description: 密码 + type: string + x-go-name: Password + type: object + x-go-name: User + type: object + x-go-name: Password + saml_auth: + description: 当认证方式为saml时，通过该字段提供SAML认证的Response信息 + properties: + response: + type: string + x-go-name: Response + type: object + x-go-name: SAMLAuth + token: + description: 当认证方式为token时，通过该字段提供token认证信息 + properties: + id: + description: token + type: string + x-go-name: Id + type: object + x-go-name: Token + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + SAuthenticationInputV2: + properties: + auth: + description: keystone v2 认证接口认证信息 + properties: + context: + $ref: '#/definitions/SAuthContext' + passwordCredentials: + description: 如果使用用户名/密码认证，则需要设置passwordCredentials + properties: + password: + description: 用户密码 + type: string + x-go-name: Password + username: + description: 用户名 + type: string + x-go-name: Username + type: object + x-go-name: PasswordCredentials + tenantId: + description: 指定认证用户的所属项目ID，该字段和tenantName二选一，或者不设置。 + type: string + x-go-name: TenantId + tenantName: + description: |- + 指定认证用户的所属项目名称，该字段和tenantId二选一，或者不设置。 + 如果不提供tenantName和tenantId，则用户认证成功后，获得一个unscoped token + 此时，如果用户需要访问具体项目的资源，还是需要用unscoped token进行认证，获得指定项目的token + type: string + x-go-name: TenantName + token: + description: 如果使用token认证，则需要设置token.Id + properties: + id: + description: token的字符串 + type: string + x-go-name: Id + type: object + x-go-name: Token + type: object + x-go-name: Auth + required: + - auth + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + SAuthenticationInputV3: + properties: + auth: + description: keystone v3 认证接口认证信息 + properties: + context: + $ref: '#/definitions/SAuthContext' + identity: + $ref: '#/definitions/SAuthenticationIdentity' + scope: + description: |- + 指定认证范围, 该字段可选。如果未指定scope，则用户认证成功后获得一个unscoped token， + 当用户需要访问指定项目的资源时，需要通过该unscope token进行认证，获得该项目scope的token + 目前只支持Project scope的token + properties: + domain: + description: 指定token的scope为指定的域 + properties: + id: + description: 指定domain的ID，ID和Name只需要指定其中一个 + type: string + x-go-name: Id + name: + description: 指定Domain的Name + type: string + x-go-name: Name + type: object + x-go-name: Domain + project: + description: 指定token的scope为指定的项目 + properties: + domain: + description: 指定项目所在的域（domain） + properties: + id: + description: 指定项目所在域的ID，ID和Name只需要指定其中一个 + type: string + x-go-name: Id + name: + description: 指定项目所在域的Name + type: string + x-go-name: Name + type: object + x-go-name: Domain + id: + description: 指定项目的ID，由于ID全局唯一，因此指定ID后不需要指定项目所在的域（Domain）,ID和Name只需要指定其中一个 + type: string + x-go-name: Id + name: + description: 指定项目的Name，指定Name时，需要指定项目所在的域（domain） + type: string + x-go-name: Name + type: object + x-go-name: Project + type: object + x-go-name: Scope + required: + - identity + type: object + x-go-name: Auth + required: + - auth + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + SDomainObject: + properties: + domain: + $ref: '#/definitions/SIdentityObject' + id: + description: UUID + type: string + x-go-name: Id + name: + description: 名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SDomainObjectWithMetadata: + properties: + domain: + $ref: '#/definitions/SIdentityObject' + id: + description: UUID + type: string + x-go-name: Id + metadata: + additionalProperties: + type: string + description: 标签信息 + type: object + x-go-name: Metadata + name: + description: 名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SFetchDomainObjectWithMetadata: + properties: + domain: + description: 归属域名称 + type: string + x-go-name: Domain + domain_id: + description: 归属域ID + type: string + x-go-name: DomainId + id: + description: UUID + type: string + x-go-name: Id + metadata: + additionalProperties: + type: string + description: 项目标签 + type: object + x-go-name: Metadata + name: + description: 名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SGroupRole: + properties: + Group: + type: string + Role: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SIdentityObject: + properties: + id: + description: UUID + type: string + x-go-name: Id + name: + description: 名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SIdentityQuotaDetail: + description: 域的认证配额详情 + properties: + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + group: + format: int64 + type: integer + x-go-name: Group + policy: + format: int64 + type: integer + x-go-name: Policy + project: + format: int64 + type: integer + x-go-name: Project + role: + format: int64 + type: integer + x-go-name: Role + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + user: + format: int64 + type: integer + x-go-name: User + type: object + x-go-package: yunion.io/x/onecloud/pkg/keystone/models + SJoinProjectsInput: + properties: + projects: + items: + type: string + type: array + x-go-name: Projects + roles: + items: + type: string + type: array + x-go-name: Roles + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SLeaveProjectsInput: + properties: + project_roles: + items: + $ref: '#/definitions/SProjectRole' + type: array + x-go-name: ProjectRoles + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SProjectAddUserGroupInput: + properties: + Groups: + items: + type: string + type: array + Roles: + items: + type: string + type: array + Users: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SProjectRemoveUserGroupInput: + properties: + GroupRoles: + items: + $ref: '#/definitions/SGroupRole' + type: array + UserRoles: + items: + $ref: '#/definitions/SUserRole' + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SProjectRole: + properties: + project: + type: string + x-go-name: Project + role: + type: string + x-go-name: Role + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SProjectSetAdminInput: + properties: + UserId: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SRoleAssignment: + properties: + group: + $ref: '#/definitions/SDomainObject' + policies: + description: 用户角色关联的权限信息 + properties: + domain: + description: 关联的域权限名称列表 + items: + type: string + type: array + x-go-name: Domain + project: + description: 关联的项目权限名称列表 + items: + type: string + type: array + x-go-name: Project + system: + description: 关联的系统权限名称列表 + items: + type: string + type: array + x-go-name: System + type: object + x-go-name: Policies + role: + $ref: '#/definitions/SDomainObject' + scope: + description: 归属范围 + properties: + domain: + $ref: '#/definitions/SIdentityObject' + project: + $ref: '#/definitions/SDomainObjectWithMetadata' + type: object + x-go-name: Scope + user: + $ref: '#/definitions/SDomainObject' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + SUserRole: + properties: + Role: + type: string + User: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + ServiceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + config_version: + format: int64 + type: integer + x-go-name: ConfigVersion + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + enabled: + type: boolean + x-go-name: Enabled + endpoint_count: + format: int64 + type: integer + x-go-name: EndpointCount + extra: + type: object + x-go-name: Extra + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + SetIdentityQuotaInput: + description: 设置域的认证配额输入参数 + properties: + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + group: + format: int64 + type: integer + x-go-name: Group + policy: + format: int64 + type: integer + x-go-name: Policy + project: + format: int64 + type: integer + x-go-name: Project + role: + format: int64 + type: integer + x-go-name: Role + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + user: + format: int64 + type: integer + x-go-name: User + type: object + x-go-package: yunion.io/x/onecloud/pkg/keystone/models + SharedDomain: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedProject: + properties: + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TConfigs: + additionalProperties: + additionalProperties: + type: object + type: object + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + TRbacScope: + type: string + x-go-package: yunion.io/x/pkg/util/rbacscope + TTagSet: + items: + $ref: '#/definitions/STag' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TokenCredentialV2: + description: Keystone token信息V2 + properties: + context: + $ref: '#/definitions/SAuthContext' + metadata: + $ref: '#/definitions/KeystoneMetadataV2' + service_catalog: + $ref: '#/definitions/KeystoneServiceCatalogV2' + tenants: + description: 用户所属项目列表 + items: + $ref: '#/definitions/KeystoneTenantV2' + type: array + x-go-name: Tenants + token: + $ref: '#/definitions/KeystoneTokenV2' + user: + $ref: '#/definitions/KeystoneUserV2' + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + TokenCredentialV3: + properties: + token: + $ref: '#/definitions/KeystoneTokenV3' + type: object + x-go-package: yunion.io/x/onecloud/pkg/mcclient + UserCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + allow_web_console: + type: boolean + x-go-name: AllowWebConsole + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + displayname: + type: string + x-go-name: Displayname + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + email: + type: string + x-go-name: Email + enable_mfa: + type: boolean + x-go-name: EnableMfa + enabled: + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + idp_entity_id: + type: string + x-go-name: IdpEntityId + idp_id: + type: string + x-go-name: IdpId + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system_account: + type: boolean + x-go-name: IsSystemAccount + lang: + type: string + x-go-name: Lang + mobile: + type: string + x-go-name: Mobile + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + password: + type: string + x-go-name: Password + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + skip_password_complexity_check: + type: boolean + x-go-name: SkipPasswordComplexityCheck + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + UserDetails: + properties: + allow_web_console: + description: 是否允许登录Web控制台，如果是用于API访问的用户，可禁用web控制台登录 + type: boolean + x-go-name: AllowWebConsole + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + credential_count: + description: 归属该用户的密钥凭证（含AKSK，TOTP，Secret等）的数量 + format: int64 + type: integer + x-go-name: CredentialCount + default_project_id: + description: deprecated + type: string + x-go-name: DefaultProjectId + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + displayname: + description: 显示名称，用户登录后显示在右上角菜单入口 + type: string + x-go-name: Displayname + domain_id: + description: 域Id + type: string + x-go-name: DomainId + email: + description: 用户邮箱 + type: string + x-go-name: Email + enable_mfa: + description: 是否开启MFA + type: boolean + x-go-name: EnableMfa + enabled: + type: boolean + x-go-name: Enabled + ext_resource: + additionalProperties: + format: int64 + type: integer + description: 外部资源统计信息（资源类别：数量） + type: object + x-go-name: ExtResource + ext_resources_last_update: + description: 外部资源统计信息上次更新时间 + format: date-time + type: string + x-go-name: ExtResourcesLastUpdate + ext_resources_next_update: + description: 外部资源统计信息下次更新时间 + format: date-time + type: string + x-go-name: ExtResourcesNextUpdate + extra: + description: 额外信息 + type: object + x-go-name: Extra + failed_auth_at: + description: 上传登录失败的时间 + format: date-time + type: string + x-go-name: FailedAuthAt + failed_auth_count: + description: 连续登录失败的次数 + format: int64 + type: integer + x-go-name: FailedAuthCount + group_count: + description: 用户归属用户组的数量 + format: int64 + type: integer + x-go-name: GroupCount + id: + description: 资源UUID + type: string + x-go-name: Id + idps: + description: 该用户关联的外部认证源的认证信息 + items: + $ref: '#/definitions/IdpResourceInfo' + type: array + x-go-name: Idps + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_local: + description: 该用户是否为本地用户（SQL维护的用户） + type: boolean + x-go-name: IsLocal + is_system_account: + description: 是否为系统账号，系统账号不会检查密码复杂度，默认不在列表显示 + type: boolean + x-go-name: IsSystemAccount + lang: + description: 用户的默认语言设置，默认是zh_CN + type: string + x-go-name: Lang + last_active_at: + description: 上次登录时间 + format: date-time + type: string + x-go-name: LastActiveAt + last_login_ip: + description: 上次用户登录IP + type: string + x-go-name: LastLoginIp + last_login_source: + description: 上次用户登录方式，可能值有：web（web控制台），cli（命令行climc），API（api） + type: string + x-go-name: LastLoginSource + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + mobile: + description: 用户手机号 + type: string + x-go-name: Mobile + name: + description: 资源名称 + type: string + x-go-name: Name + need_reset_password: + description: 登录后是否需要重置密码 + type: boolean + x-go-name: NeedResetPassword + password_expires_at: + description: 密码过期时间（如果开启了密码过期） + format: date-time + type: string + x-go-name: PasswordExpiresAt + password_reset_hint: + description: '重置密码原因: admin_reset|expire' + type: string + x-go-name: PasswordResetHint + project_count: + description: 用户归属项目的数量 + format: int64 + type: integer + x-go-name: ProjectCount + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + projects: + description: 用户归属的的项目信息 + items: + $ref: '#/definitions/SFetchDomainObjectWithMetadata' + type: array + x-go-name: Projects + record_checksum: + type: string + x-go-name: RecordChecksum + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + UserLinkIdpInput: + properties: + idp_entity_id: + type: string + x-go-name: IdpEntityId + idp_id: + type: string + x-go-name: IdpId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity + UserUnlinkIdpInput: + $ref: '#/definitions/UserLinkIdpInput' + UserUpdateInput: + properties: + allow_web_console: + type: boolean + x-go-name: AllowWebConsole + description: + description: 资源描述 + type: string + x-go-name: Description + displayname: + type: string + x-go-name: Displayname + email: + type: string + x-go-name: Email + enable_mfa: + type: boolean + x-go-name: EnableMfa + enabled: + description: 是否启用 + type: boolean + x-go-name: Enabled + is_system_account: + type: boolean + x-go-name: IsSystemAccount + lang: + type: string + x-go-name: Lang + mobile: + type: string + x-go-name: Mobile + name: + description: 资源名称 + type: string + x-go-name: Name + password: + type: string + x-go-name: Password + skip_password_complexity_check: + type: boolean + x-go-name: SkipPasswordComplexityCheck + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/identity +host: '"127.0.0.1:8889"' +info: + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Identity API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" +paths: + /credentials: + get: + description: 列表 + operationId: credential_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 用户归属域 + in: query + name: user_domain_id + type: string + x-go-name: UserDomainId + - description: filter by user + in: query + name: user_id + type: string + x-go-name: UserId + - description: 项目归属域 + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 以项目（ID或Name）过滤列表结果 + in: query + name: project_id + type: string + x-go-name: ProjectId + - in: query + items: + type: string + name: type + type: array + x-go-name: Type + - in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/credential_ListItemFilterOutput' + summary: 用户信用凭证列表 + tags: + - credential + post: + description: 新建 + operationId: credential_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + credential: + $ref: '#/definitions/CredentialCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/credential_ValidateCreateDataOutput' + summary: 新建 + tags: + - credential + /credentials/{id}: + delete: + description: 删除 + operationId: credential_CustomizeDelete + parameters: + - description: The Id or Name of credential + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/credential_CustomizeDeleteOutput' + summary: 删除 + tags: + - credential + get: + description: 获取详情 + operationId: credential_FetchCustomizeColumns + parameters: + - description: The Id or Name of credential + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/credential_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - credential + put: + description: 更新 + operationId: credential_ValidateUpdateData + parameters: + - description: The Id or Name of credential + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + credential: + $ref: '#/definitions/CredentialUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/credential_ValidateUpdateDataOutput' + summary: 更新 + tags: + - credential + /credentials/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: credential_GetDetailsClassMetadata + parameters: + - description: The Id or Name of credential + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/credential_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - credential + post: + description: 执行操作ClassMetadata + operationId: credential_PerformClassMetadata + parameters: + - description: The Id or Name of credential + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + credential: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/credential_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - credential + /credentials/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: credential_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of credential + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/credential_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - credential + /credentials/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: credential_PerformSetClassMetadata + parameters: + - description: The Id or Name of credential + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + credential: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/credential_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - credential + /credentials/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: credential_PerformSetUserMetadata + parameters: + - description: The Id or Name of credential + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + credential: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/credential_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - credential + /credentials/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: credential_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/credential_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - credential + /credentials/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: credential_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + credential: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/credential_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - credential + /credentials/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: credential_GetPropertySplitable + responses: + "200": + $ref: '#/responses/credential_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - credential + /credentials/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: credential_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/credential_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - credential + /credentials/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: credential_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/credential_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - credential + /credentials/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: credential_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/credential_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - credential + /domains: + get: + description: 列表 + operationId: domain_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 按IDP过滤 + in: query + name: idp_id + type: string + x-go-name: IdpId + - description: 按IDP_ENTITY_ID过滤 + in: query + name: idp_entity_id + type: string + x-go-name: IdpEntityId + - $ref: '#/definitions/TTagSetList' + description: domain tags filter imposed by policy + in: query + name: policy_domain_tags + x-go-name: PolicyDomainTags + responses: + "200": + $ref: '#/responses/domain_ListItemFilterOutput' + summary: 域列表 + tags: + - domain + post: + description: 新建 + operationId: domain_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + domain: + $ref: '#/definitions/DomainCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/domain_ValidateCreateDataOutput' + summary: 新建 + tags: + - domain + /domains/{id}: + delete: + description: 删除 + operationId: domain_CustomizeDelete + parameters: + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/domain_CustomizeDeleteOutput' + summary: 删除 + tags: + - domain + get: + description: 获取详情 + operationId: domain_FetchCustomizeColumns + parameters: + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/domain_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - domain + put: + description: 更新 + operationId: domain_ValidateUpdateData + parameters: + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + domain: + $ref: '#/definitions/DomainUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/domain_ValidateUpdateDataOutput' + summary: 更新 + tags: + - domain + /domains/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: domain_GetDetailsClassMetadata + parameters: + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/domain_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - domain + post: + description: 执行操作ClassMetadata + operationId: domain_PerformClassMetadata + parameters: + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/domain_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - domain + /domains/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: domain_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/domain_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - domain + /domains/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: domain_PerformSetClassMetadata + parameters: + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/domain_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - domain + /domains/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: domain_PerformSetUserMetadata + parameters: + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + domain: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/domain_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - domain + /domains/{id}/unlink-idp: + post: + description: 执行操作UnlinkIdp + operationId: domain_PerformUnlinkIdp + parameters: + - description: The Id or Name of domain + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + domain: + $ref: '#/definitions/UserUnlinkIdpInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/domain_PerformUnlinkIdpOutput' + summary: domain和IDP的指定entityId解除关联 + tags: + - domain + /domains/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: domain_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/domain_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - domain + /domains/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: domain_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + domain: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/domain_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - domain + /domains/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: domain_GetPropertySplitable + responses: + "200": + $ref: '#/responses/domain_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - domain + /domains/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: domain_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/domain_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - domain + /domains/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: domain_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/domain_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - domain + /domains/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: domain_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/domain_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - domain + /endpoints: + get: + description: 列表 + operationId: endpoint_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 服务类型过滤 + in: query + name: service_type + type: string + x-go-name: ServiceType + - description: 服务名称或ID过滤 + in: query + name: service_id + type: string + x-go-name: ServiceId + - description: 以服务名称排序 + in: query + name: order_by_service + type: string + x-go-name: OrderByService + - description: 以区域名称或ID过滤 + in: query + name: region_id + type: string + x-go-name: RegionId + - description: '以Endpoint接口类型过滤，可能值为: internal, internalURL, public, publicURL, + admin, adminURL, console' + in: query + name: interface + type: string + x-go-name: Interface + - description: 是否启用 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/endpoint_ListItemFilterOutput' + summary: 服务地址列表 + tags: + - endpoint + post: + description: 新建 + operationId: endpoint_ValidateCreateData + responses: + "200": + $ref: '#/responses/endpoint_ValidateCreateDataOutput' + summary: 新建 + tags: + - endpoint + /endpoints/{id}: + delete: + description: 删除 + operationId: endpoint_CustomizeDelete + parameters: + - description: The Id or Name of endpoint + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/endpoint_CustomizeDeleteOutput' + summary: 删除 + tags: + - endpoint + get: + description: 获取详情 + operationId: endpoint_FetchCustomizeColumns + parameters: + - description: The Id or Name of endpoint + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/endpoint_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - endpoint + put: + description: 更新 + operationId: endpoint_ValidateUpdateData + parameters: + - description: The Id or Name of endpoint + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/endpoint_ValidateUpdateDataOutput' + summary: 更新 + tags: + - endpoint + /endpoints/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: endpoint_GetDetailsClassMetadata + parameters: + - description: The Id or Name of endpoint + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/endpoint_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - endpoint + post: + description: 执行操作ClassMetadata + operationId: endpoint_PerformClassMetadata + parameters: + - description: The Id or Name of endpoint + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + endpoint: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/endpoint_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - endpoint + /endpoints/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: endpoint_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of endpoint + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/endpoint_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - endpoint + /endpoints/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: endpoint_PerformSetClassMetadata + parameters: + - description: The Id or Name of endpoint + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + endpoint: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/endpoint_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - endpoint + /endpoints/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: endpoint_PerformSetUserMetadata + parameters: + - description: The Id or Name of endpoint + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + endpoint: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/endpoint_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - endpoint + /endpoints/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: endpoint_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/endpoint_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - endpoint + /endpoints/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: endpoint_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + endpoint: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/endpoint_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - endpoint + /endpoints/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: endpoint_GetPropertySplitable + responses: + "200": + $ref: '#/responses/endpoint_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - endpoint + /endpoints/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: endpoint_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/endpoint_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - endpoint + /endpoints/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: endpoint_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/endpoint_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - endpoint + /endpoints/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: endpoint_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/endpoint_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - endpoint + /groups: + get: + description: 列表 + operationId: group_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 用户归属域 + in: query + name: user_domain_id + type: string + x-go-name: UserDomainId + - description: filter by user + in: query + name: user_id + type: string + x-go-name: UserId + - description: 项目归属域 + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 以项目（ID或Name）过滤列表结果 + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 名称过滤 + in: query + name: displayname + type: string + x-go-name: Displayname + - description: 按IDP过滤 + in: query + name: idp_id + type: string + x-go-name: IdpId + responses: + "200": + $ref: '#/responses/group_ListItemFilterOutput' + summary: 用户组列表 + tags: + - group + post: + description: 新建 + operationId: group_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + group: + $ref: '#/definitions/GroupCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_ValidateCreateDataOutput' + summary: 新建 + tags: + - group + /groups/{id}: + delete: + description: 删除 + operationId: group_CustomizeDelete + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_CustomizeDeleteOutput' + summary: 删除 + tags: + - group + get: + description: 获取详情 + operationId: group_FetchCustomizeColumns + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - group + put: + description: 更新 + operationId: group_ValidateUpdateData + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/GroupUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_ValidateUpdateDataOutput' + summary: 更新 + tags: + - group + /groups/{id}/add-users: + post: + description: 执行操作AddUsers + operationId: group_PerformAddUsers + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PerformGroupAddUsersInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformAddUsersOutput' + summary: 组添加用户 + tags: + - group + /groups/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: group_GetDetailsClassMetadata + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - group + post: + description: 执行操作ClassMetadata + operationId: group_PerformClassMetadata + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - group + /groups/{id}/join: + post: + description: 执行操作Join + operationId: group_PerformJoin + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/SJoinProjectsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformJoinOutput' + summary: 组加入项目 + tags: + - group + /groups/{id}/leave: + post: + description: 执行操作Leave + operationId: group_PerformLeave + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/SLeaveProjectsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformLeaveOutput' + summary: 组退出项目 + tags: + - group + /groups/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: group_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/group_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - group + /groups/{id}/remove-users: + post: + description: 执行操作RemoveUsers + operationId: group_PerformRemoveUsers + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PerformGroupRemoveUsersInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformRemoveUsersOutput' + summary: 组删除用户 + tags: + - group + /groups/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: group_PerformSetClassMetadata + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - group + /groups/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: group_PerformSetUserMetadata + parameters: + - description: The Id or Name of group + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - group + /groups/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: group_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/group_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - group + /groups/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: group_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/group_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - group + /groups/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: group_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/group_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - group + /groups/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: group_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + group: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/group_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - group + /groups/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: group_GetPropertySplitable + responses: + "200": + $ref: '#/responses/group_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - group + /groups/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: group_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/group_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - group + /groups/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: group_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/group_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - group + /groups/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: group_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/group_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - group + /identity_providers: + get: + description: 列表 + operationId: identity_provider_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以驱动类型过滤 + in: query + items: + type: string + name: driver + type: array + x-go-name: Driver + - description: 以模板过滤 + in: query + items: + type: string + name: template + type: array + x-go-name: Template + - description: 以同步状态过滤 + in: query + items: + type: string + name: sync_status + type: array + x-go-name: SyncStatus + - description: 过滤支持SSO的认证源，如果值为all，则列出所有的全局认证源，否则可出sso为域ID的域认证源 + example: all + in: query + name: sso + type: string + x-go-name: SsoDomain + - in: query + name: auto_create_project + type: boolean + x-go-name: AutoCreateProject + - in: query + name: auto_create_user + type: boolean + x-go-name: AutoCreateUser + responses: + "200": + $ref: '#/responses/identity_provider_ListItemFilterOutput' + summary: 列表 + tags: + - identity_provider + post: + description: 新建 + operationId: identity_provider_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + identity_provider: + $ref: '#/definitions/IdentityProviderCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_ValidateCreateDataOutput' + summary: 新建 + tags: + - identity_provider + /identity_providers/{id}: + delete: + description: 删除 + operationId: identity_provider_CustomizeDelete + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_CustomizeDeleteOutput' + summary: 删除 + tags: + - identity_provider + get: + description: 获取详情 + operationId: identity_provider_FetchCustomizeColumns + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - identity_provider + put: + description: 更新 + operationId: identity_provider_ValidateUpdateData + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_ValidateUpdateDataOutput' + summary: 更新 + tags: + - identity_provider + /identity_providers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: identity_provider_GetDetailsClassMetadata + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - identity_provider + post: + description: 执行操作ClassMetadata + operationId: identity_provider_PerformClassMetadata + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - identity_provider + /identity_providers/{id}/config: + get: + description: 获取指定信息Config + operationId: identity_provider_GetDetailsConfig + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_GetDetailsConfigOutput' + summary: 获取指定信息Config + tags: + - identity_provider + post: + description: 执行操作Config + operationId: identity_provider_PerformConfig + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + $ref: '#/definitions/PerformConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformConfigOutput' + summary: 配置认证源 + tags: + - identity_provider + /identity_providers/{id}/default-sso: + post: + description: 执行操作DefaultSso + operationId: identity_provider_PerformDefaultSso + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + $ref: '#/definitions/PerformDefaultSsoInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformDefaultSsoOutput' + summary: 执行操作DefaultSso + tags: + - identity_provider + /identity_providers/{id}/disable: + post: + description: 执行操作Disable + operationId: identity_provider_PerformDisable + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformDisableOutput' + summary: 执行操作Disable + tags: + - identity_provider + /identity_providers/{id}/enable: + post: + description: 执行操作Enable + operationId: identity_provider_PerformEnable + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformEnableOutput' + summary: 执行操作Enable + tags: + - identity_provider + /identity_providers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: identity_provider_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - identity_provider + /identity_providers/{id}/saml-metadata: + get: + description: 获取指定信息SamlMetadata + operationId: identity_provider_GetDetailsSamlMetadata + parameters: + - description: 缩进展示SAML sp metadata + in: query + name: pretty + type: boolean + x-go-name: Pretty + - description: AssertionConsumer callback URL + in: query + name: redirect_uri + type: string + x-go-name: RedirectUri + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_GetDetailsSamlMetadataOutput' + summary: 获取指定信息SamlMetadata + tags: + - identity_provider + /identity_providers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: identity_provider_PerformSetClassMetadata + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - identity_provider + /identity_providers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: identity_provider_PerformSetUserMetadata + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - identity_provider + /identity_providers/{id}/sso-callback-uri: + get: + description: 获取指定信息SsoCallbackUri + operationId: identity_provider_GetDetailsSsoCallbackUri + parameters: + - description: SSO回调地址 + in: query + name: redirect_uri + type: string + x-go-name: RedirectUri + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_GetDetailsSsoCallbackUriOutput' + summary: 获取指定信息SsoCallbackUri + tags: + - identity_provider + /identity_providers/{id}/sso-redirect-uri: + get: + description: 获取指定信息SsoRedirectUri + operationId: identity_provider_GetDetailsSsoRedirectUri + parameters: + - description: SSO回调地址 + in: query + name: redirect_uri + type: string + x-go-name: RedirectUri + - description: SSO状态信息 + in: query + name: state + type: string + x-go-name: State + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_GetDetailsSsoRedirectUriOutput' + summary: 获取指定信息SsoRedirectUri + tags: + - identity_provider + /identity_providers/{id}/status: + get: + description: 获取指定信息Status + operationId: identity_provider_GetDetailsStatus + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - identity_provider + post: + description: 执行操作Status + operationId: identity_provider_PerformStatus + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + identity_provider: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformStatusOutput' + summary: 更新资源状态 + tags: + - identity_provider + /identity_providers/{id}/sync: + post: + description: 执行操作Sync + operationId: identity_provider_PerformSync + parameters: + - description: The Id or Name of identity_provider + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/identity_provider_PerformSyncOutput' + summary: 手动同步认证源 + tags: + - identity_provider + /identity_providers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: identity_provider_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/identity_provider_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - identity_provider + /identity_providers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: identity_provider_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + identity_provider: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/identity_provider_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - identity_provider + /identity_providers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: identity_provider_GetPropertySplitable + responses: + "200": + $ref: '#/responses/identity_provider_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - identity_provider + /identity_providers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: identity_provider_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/identity_provider_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - identity_provider + /identity_providers/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: identity_provider_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/identity_provider_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - identity_provider + /identity_providers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: identity_provider_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/identity_provider_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - identity_provider + /identity_providers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: identity_provider_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/identity_provider_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - identity_provider + /identity_quotas/domains: + get: + description: 获取所有域的域配额 + operationId: models_ListIdentityQuotas + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + responses: + "200": + $ref: '#/responses/models_ListIdentityQuotasOutput' + summary: 获取所有域的域配额 + tags: + - identity_quota + /identity_quotas/domains/{domainId}: + get: + description: 获取指定域的认证配额 + operationId: models_GetIdentityQuota + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 指定域的ID + in: path + name: domainId + required: true + type: string + x-go-name: DomainId + responses: + "200": + $ref: '#/responses/models_GetIdentityQuotaOutput' + summary: 获取指定域的认证配额 + tags: + - identity_quota + post: + description: 设置域的认证配额 + operationId: models_SetIdentityQuotas + parameters: + - description: 指定域的ID + in: path + name: domainId + required: true + type: string + x-go-name: DomainId + - in: body + name: body + schema: + properties: + identity_quotas: + $ref: '#/definitions/SetIdentityQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetIdentityQuotasOutput' + summary: 设置域的认证配额 + tags: + - identity_quota + /policies: + get: + description: 列表 + operationId: policy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: filter by enabled status + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以类型查询 + in: query + items: + type: string + name: type + type: array + x-go-name: Type + - description: 是否显示系统权限 + in: query + name: is_system + type: boolean + x-go-name: IsSystem + - description: filter policies by role id + in: query + name: role_id + type: string + x-go-name: RoleId + - description: |- + swagger: ignore + Deprecated + in: query + name: role + type: string + x-go-name: Role + responses: + "200": + $ref: '#/responses/policy_ListItemFilterOutput' + summary: 权限策略列表 + tags: + - policy + post: + description: 新建 + operationId: policy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + policy: + $ref: '#/definitions/PolicyCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_ValidateCreateDataOutput' + summary: 新建 + tags: + - policy + /policies/{id}: + delete: + description: 删除 + operationId: policy_CustomizeDelete + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_CustomizeDeleteOutput' + summary: 删除 + tags: + - policy + get: + description: 获取详情 + operationId: policy_FetchCustomizeColumns + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - policy + put: + description: 更新 + operationId: policy_ValidateUpdateData + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy: + $ref: '#/definitions/PolicyUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - policy + /policies/{id}/bind-role: + post: + description: 执行操作BindRole + operationId: policy_PerformBindRole + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy: + $ref: '#/definitions/PolicyBindRoleInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformBindRoleOutput' + summary: 绑定角色 + tags: + - policy + /policies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: policy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - policy + post: + description: 执行操作ClassMetadata + operationId: policy_PerformClassMetadata + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - policy + /policies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: policy_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/policy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - policy + /policies/{id}/private: + post: + description: 执行操作Private + operationId: policy_PerformPrivate + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformPrivateOutput' + summary: 设置policy为私有 + tags: + - policy + /policies/{id}/public: + post: + description: 执行操作Public + operationId: policy_PerformPublic + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformPublicOutput' + summary: 共享Policy + tags: + - policy + /policies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: policy_PerformSetClassMetadata + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - policy + /policies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: policy_PerformSetUserMetadata + parameters: + - description: The Id or Name of policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + policy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - policy + /policies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: policy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/policy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - policy + /policies/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: policy_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/policy_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - policy + /policies/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: policy_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/policy_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - policy + /policies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: policy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + policy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/policy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - policy + /policies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: policy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/policy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - policy + /policies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: policy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/policy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - policy + /policies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: policy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/policy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - policy + /policies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: policy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/policy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - policy + /projects: + get: + description: 列表 + operationId: project_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 用户归属域 + in: query + name: user_domain_id + type: string + x-go-name: UserDomainId + - description: filter by user + in: query + name: user_id + type: string + x-go-name: UserId + - description: 组归属域 + in: query + name: group_domain_id + type: string + x-go-name: GroupDomainId + - description: filter by group + in: query + name: group_id + type: string + x-go-name: GroupId + - description: filter projects by Identity Provider + in: query + name: idp_id + type: string + x-go-name: IdpId + - description: 过滤出指定用户或者组可以加入的项目 + in: query + name: jointable + type: boolean + x-go-name: Jointable + - $ref: '#/definitions/TTagSetList' + description: project tags filter imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + responses: + "200": + $ref: '#/responses/project_ListItemFilterOutput' + summary: 项目列表 + tags: + - project + post: + description: 新建 + operationId: project_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + project: + $ref: '#/definitions/ProjectCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_ValidateCreateDataOutput' + summary: 新建 + tags: + - project + /projects/{id}: + delete: + description: 删除 + operationId: project_CustomizeDelete + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_CustomizeDeleteOutput' + summary: 删除 + tags: + - project + get: + description: 获取详情 + operationId: project_FetchCustomizeColumns + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - project + put: + description: 更新 + operationId: project_ValidateUpdateData + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project: + $ref: '#/definitions/ProjectUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_ValidateUpdateDataOutput' + summary: 更新 + tags: + - project + /projects/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: project_GetDetailsClassMetadata + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - project + post: + description: 执行操作ClassMetadata + operationId: project_PerformClassMetadata + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - project + /projects/{id}/join: + post: + description: 执行操作Join + operationId: project_PerformJoin + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project: + $ref: '#/definitions/SProjectAddUserGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_PerformJoinOutput' + summary: 将用户或组加入项目 + tags: + - project + /projects/{id}/leave: + post: + description: 执行操作Leave + operationId: project_PerformLeave + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project: + $ref: '#/definitions/SProjectRemoveUserGroupInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_PerformLeaveOutput' + summary: 将用户或组移出项目 + tags: + - project + /projects/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: project_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/project_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - project + /projects/{id}/set-admin: + post: + description: 执行操作SetAdmin + operationId: project_PerformSetAdmin + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project: + $ref: '#/definitions/SProjectSetAdminInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_PerformSetAdminOutput' + summary: 执行操作SetAdmin + tags: + - project + /projects/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: project_PerformSetClassMetadata + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - project + /projects/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: project_PerformSetUserMetadata + parameters: + - description: The Id or Name of project + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + project: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - project + /projects/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: project_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/project_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - project + /projects/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: project_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/project_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - project + /projects/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: project_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/project_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - project + /projects/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: project_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + project: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/project_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - project + /projects/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: project_GetPropertySplitable + responses: + "200": + $ref: '#/responses/project_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - project + /projects/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: project_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/project_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - project + /projects/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: project_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/project_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - project + /projects/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: project_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/project_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - project + /regions: + get: + description: 列表 + operationId: region_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + responses: + "200": + $ref: '#/responses/region_ListItemFilterOutput' + summary: 区域列表 + tags: + - region + post: + description: 新建 + operationId: region_ValidateCreateData + responses: + "200": + $ref: '#/responses/region_ValidateCreateDataOutput' + summary: 新建 + tags: + - region + /regions/{id}: + delete: + description: 删除 + operationId: region_CustomizeDelete + parameters: + - description: The Id or Name of region + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/region_CustomizeDeleteOutput' + summary: 删除 + tags: + - region + get: + description: 获取详情 + operationId: region_FetchCustomizeColumns + parameters: + - description: The Id or Name of region + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/region_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - region + put: + description: 更新 + operationId: region_ValidateUpdateData + parameters: + - description: The Id or Name of region + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + region: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/region_ValidateUpdateDataOutput' + summary: 更新 + tags: + - region + /regions/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: region_GetDetailsClassMetadata + parameters: + - description: The Id or Name of region + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/region_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - region + post: + description: 执行操作ClassMetadata + operationId: region_PerformClassMetadata + parameters: + - description: The Id or Name of region + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + region: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/region_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - region + /regions/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: region_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of region + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/region_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - region + /regions/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: region_PerformSetClassMetadata + parameters: + - description: The Id or Name of region + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + region: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/region_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - region + /regions/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: region_PerformSetUserMetadata + parameters: + - description: The Id or Name of region + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + region: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/region_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - region + /regions/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: region_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/region_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - region + /regions/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: region_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + region: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/region_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - region + /regions/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: region_GetPropertySplitable + responses: + "200": + $ref: '#/responses/region_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - region + /regions/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: region_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/region_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - region + /regions/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: region_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/region_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - region + /regions/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: region_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/region_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - region + /role_policies: + get: + description: 列表 + operationId: role_policy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - in: query + items: + type: string + name: role_ids + type: array + x-go-name: RoleIds + - in: query + name: project_id + type: string + x-go-name: ProjectId + - in: query + name: policy_id + type: string + x-go-name: PolicyId + - in: query + name: auth + type: boolean + x-go-name: Auth + responses: + "200": + $ref: '#/responses/role_policy_ListItemFilterOutput' + summary: 列表 + tags: + - role_policy + post: + description: 新建 + operationId: role_policy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + role_policy: + $ref: '#/definitions/ResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_policy_ValidateCreateDataOutput' + summary: 新建 + tags: + - role_policy + /role_policies/{id}: + delete: + description: 删除 + operationId: role_policy_CustomizeDelete + parameters: + - description: The Id or Name of role_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/role_policy_CustomizeDeleteOutput' + summary: 删除 + tags: + - role_policy + get: + description: 获取详情 + operationId: role_policy_FetchCustomizeColumns + parameters: + - description: The Id or Name of role_policy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/role_policy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - role_policy + put: + description: 更新 + operationId: role_policy_ValidateUpdateData + parameters: + - description: The Id or Name of role_policy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role_policy: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_policy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - role_policy + /role_policies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: role_policy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/role_policy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - role_policy + /role_policies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: role_policy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + role_policy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_policy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - role_policy + /role_policies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: role_policy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/role_policy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - role_policy + /role_policies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: role_policy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/role_policy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - role_policy + /roles: + get: + description: 列表 + operationId: role_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 项目归属域 + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 以项目（ID或Name）过滤列表结果 + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 用户归属域 + in: query + name: user_domain_id + type: string + x-go-name: UserDomainId + - description: filter by user + in: query + name: user_id + type: string + x-go-name: UserId + - description: 组归属域 + in: query + name: group_domain_id + type: string + x-go-name: GroupDomainId + - description: filter by group + in: query + name: group_id + type: string + x-go-name: GroupId + responses: + "200": + $ref: '#/responses/role_ListItemFilterOutput' + summary: 角色列表 + tags: + - role + post: + description: 新建 + operationId: role_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + role: + $ref: '#/definitions/RoleCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_ValidateCreateDataOutput' + summary: 新建 + tags: + - role + /roles/{id}: + delete: + description: 删除 + operationId: role_CustomizeDelete + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/role_CustomizeDeleteOutput' + summary: 删除 + tags: + - role + get: + description: 获取详情 + operationId: role_FetchCustomizeColumns + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/role_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - role + put: + description: 更新 + operationId: role_ValidateUpdateData + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + $ref: '#/definitions/RoleUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_ValidateUpdateDataOutput' + summary: 更新 + tags: + - role + /roles/{id}/add-policy: + post: + description: 执行操作AddPolicy + operationId: role_PerformAddPolicy + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + $ref: '#/definitions/RolePerformAddPolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformAddPolicyOutput' + summary: 执行操作AddPolicy + tags: + - role + /roles/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: role_GetDetailsClassMetadata + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/role_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - role + post: + description: 执行操作ClassMetadata + operationId: role_PerformClassMetadata + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - role + /roles/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: role_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/role_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - role + /roles/{id}/private: + post: + description: 执行操作Private + operationId: role_PerformPrivate + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformPrivateOutput' + summary: 执行操作Private + tags: + - role + /roles/{id}/public: + post: + description: 执行操作Public + operationId: role_PerformPublic + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformPublicOutput' + summary: 执行操作Public + tags: + - role + /roles/{id}/remove-policy: + post: + description: 执行操作RemovePolicy + operationId: role_PerformRemovePolicy + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + $ref: '#/definitions/RolePerformRemovePolicyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformRemovePolicyOutput' + summary: 执行操作RemovePolicy + tags: + - role + /roles/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: role_PerformSetClassMetadata + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - role + /roles/{id}/set-policies: + post: + description: 执行操作SetPolicies + operationId: role_PerformSetPolicies + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + $ref: '#/definitions/RolePerformSetPoliciesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformSetPoliciesOutput' + summary: 执行操作SetPolicies + tags: + - role + /roles/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: role_PerformSetUserMetadata + parameters: + - description: The Id or Name of role + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + role: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - role + /roles/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: role_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/role_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - role + /roles/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: role_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/role_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - role + /roles/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: role_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/role_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - role + /roles/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: role_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + role: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/role_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - role + /roles/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: role_GetPropertySplitable + responses: + "200": + $ref: '#/responses/role_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - role + /roles/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: role_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/role_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - role + /roles/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: role_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/role_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - role + /roles/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: role_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/role_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - role + /scope_resources: + get: + description: 列表 + operationId: scope_resource_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/scope_resource_ListItemFilterOutput' + summary: 列表 + tags: + - scope_resource + post: + description: 新建 + operationId: scope_resource_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scope_resource: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scope_resource_ValidateCreateDataOutput' + summary: 新建 + tags: + - scope_resource + /scope_resources/{id}: + delete: + description: 删除 + operationId: scope_resource_CustomizeDelete + parameters: + - description: The Id or Name of scope_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scope_resource_CustomizeDeleteOutput' + summary: 删除 + tags: + - scope_resource + get: + description: 获取详情 + operationId: scope_resource_FetchCustomizeColumns + parameters: + - description: The Id or Name of scope_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scope_resource_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scope_resource + put: + description: 更新 + operationId: scope_resource_ValidateUpdateData + parameters: + - description: The Id or Name of scope_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scope_resource_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scope_resource + /scope_resources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scope_resource_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scope_resource_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scope_resource + /scope_resources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scope_resource_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scope_resource: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scope_resource_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scope_resource + /scope_resources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scope_resource_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scope_resource_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scope_resource + /scope_resources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scope_resource_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scope_resource_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scope_resource + /service_certificates: + get: + description: 列表 + operationId: service_certificate_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + responses: + "200": + $ref: '#/responses/service_certificate_ListItemFilterOutput' + summary: 列表 + tags: + - service_certificate + post: + description: 新建 + operationId: service_certificate_ValidateCreateData + responses: + "200": + $ref: '#/responses/service_certificate_ValidateCreateDataOutput' + summary: 新建 + tags: + - service_certificate + /service_certificates/{id}: + delete: + description: 删除 + operationId: service_certificate_CustomizeDelete + parameters: + - description: The Id or Name of service_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_certificate_CustomizeDeleteOutput' + summary: 删除 + tags: + - service_certificate + get: + description: 获取详情 + operationId: service_certificate_FetchCustomizeColumns + parameters: + - description: The Id or Name of service_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_certificate_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - service_certificate + put: + description: 更新 + operationId: service_certificate_ValidateUpdateData + parameters: + - description: The Id or Name of service_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_certificate_ValidateUpdateDataOutput' + summary: 更新 + tags: + - service_certificate + /service_certificates/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: service_certificate_GetDetailsClassMetadata + parameters: + - description: The Id or Name of service_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_certificate_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - service_certificate + post: + description: 执行操作ClassMetadata + operationId: service_certificate_PerformClassMetadata + parameters: + - description: The Id or Name of service_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_certificate_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - service_certificate + /service_certificates/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: service_certificate_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of service_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_certificate_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - service_certificate + /service_certificates/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: service_certificate_PerformSetClassMetadata + parameters: + - description: The Id or Name of service_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_certificate_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - service_certificate + /service_certificates/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: service_certificate_PerformSetUserMetadata + parameters: + - description: The Id or Name of service_certificate + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service_certificate: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_certificate_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - service_certificate + /service_certificates/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: service_certificate_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/service_certificate_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - service_certificate + /service_certificates/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: service_certificate_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + service_certificate: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_certificate_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - service_certificate + /service_certificates/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: service_certificate_GetPropertySplitable + responses: + "200": + $ref: '#/responses/service_certificate_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - service_certificate + /service_certificates/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: service_certificate_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/service_certificate_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - service_certificate + /service_certificates/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: service_certificate_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/service_certificate_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - service_certificate + /service_certificates/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: service_certificate_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/service_certificate_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - service_certificate + /services: + get: + description: 列表 + operationId: service_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以Service Type过滤 + in: query + items: + type: string + name: type + type: array + x-go-name: Type + - description: 是否启用/禁用 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/service_ListItemFilterOutput' + summary: 服务列表 + tags: + - service + post: + description: 新建 + operationId: service_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + service: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_ValidateCreateDataOutput' + summary: 新建 + tags: + - service + /services/{id}: + delete: + description: 删除 + operationId: service_CustomizeDelete + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_CustomizeDeleteOutput' + summary: 删除 + tags: + - service + get: + description: 获取详情 + operationId: service_FetchCustomizeColumns + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - service + put: + description: 更新 + operationId: service_ValidateUpdateData + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_ValidateUpdateDataOutput' + summary: 更新 + tags: + - service + /services/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: service_GetDetailsClassMetadata + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - service + post: + description: 执行操作ClassMetadata + operationId: service_PerformClassMetadata + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - service + /services/{id}/config: + get: + description: 获取指定信息Config + operationId: service_GetDetailsConfig + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_GetDetailsConfigOutput' + summary: 获取指定信息Config + tags: + - service + post: + description: 执行操作Config + operationId: service_PerformConfig + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service: + $ref: '#/definitions/PerformConfigInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_PerformConfigOutput' + summary: 执行操作Config + tags: + - service + /services/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: service_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/service_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - service + /services/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: service_PerformSetClassMetadata + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - service + /services/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: service_PerformSetUserMetadata + parameters: + - description: The Id or Name of service + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + service: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - service + /services/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: service_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/service_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - service + /services/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: service_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + service: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/service_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - service + /services/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: service_GetPropertySplitable + responses: + "200": + $ref: '#/responses/service_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - service + /services/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: service_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/service_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - service + /services/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: service_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/service_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - service + /services/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: service_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/service_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - service + /users: + get: + description: 列表 + operationId: user_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: filter by enabled status + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 组归属域 + in: query + name: group_domain_id + type: string + x-go-name: GroupDomainId + - description: filter by group + in: query + name: group_id + type: string + x-go-name: GroupId + - description: 项目归属域 + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 以项目（ID或Name）过滤列表结果 + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 角色归属域 + in: query + name: role_domain_id + type: string + x-go-name: RoleDomainId + - description: filter by role + in: query + name: role_id + type: string + x-go-name: RoleId + - description: 角色生效所在的域 + in: query + name: role_assignment_domain_id + type: string + x-go-name: RoleAssignmentDomainId + - description: 角色生效所在的项目 + in: query + name: role_assignment_project_id + type: string + x-go-name: RoleAssignmentProjectId + - description: email + in: query + name: email + type: string + x-go-name: Email + - description: mobile + in: query + name: mobile + type: string + x-go-name: Mobile + - description: displayname + in: query + name: displayname + type: string + x-go-name: Displayname + - description: 是否允许web控制台登录 + in: query + name: allow_web_console + type: boolean + x-go-name: AllowWebConsole + - description: 是否开启MFA认证 + in: query + name: enable_mfa + type: boolean + x-go-name: EnableMfa + - description: 关联IDP + in: query + name: idp_id + type: string + x-go-name: IdpId + - description: 按IDP_ENTITY_ID过滤 + in: query + name: idp_entity_id + type: string + x-go-name: IdpEntityId + responses: + "200": + $ref: '#/responses/user_ListItemFilterOutput' + summary: 用户列表 + tags: + - user + post: + description: 新建 + operationId: user_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + user: + $ref: '#/definitions/UserCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_ValidateCreateDataOutput' + summary: 新建 + tags: + - user + /users/{id}: + delete: + description: 删除 + operationId: user_CustomizeDelete + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/user_CustomizeDeleteOutput' + summary: 删除 + tags: + - user + get: + description: 获取详情 + operationId: user_FetchCustomizeColumns + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/user_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - user + put: + description: 更新 + operationId: user_ValidateUpdateData + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + $ref: '#/definitions/UserUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_ValidateUpdateDataOutput' + summary: 更新 + tags: + - user + /users/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: user_GetDetailsClassMetadata + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/user_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - user + post: + description: 执行操作ClassMetadata + operationId: user_PerformClassMetadata + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - user + /users/{id}/join: + post: + description: 执行操作Join + operationId: user_PerformJoin + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + $ref: '#/definitions/SJoinProjectsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformJoinOutput' + summary: 用户加入项目 + tags: + - user + /users/{id}/leave: + post: + description: 执行操作Leave + operationId: user_PerformLeave + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + $ref: '#/definitions/SLeaveProjectsInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformLeaveOutput' + summary: 用户退出项目 + tags: + - user + /users/{id}/link-idp: + post: + description: 执行操作LinkIdp + operationId: user_PerformLinkIdp + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + $ref: '#/definitions/UserLinkIdpInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformLinkIdpOutput' + summary: 用户和IDP的指定entityId关联 + tags: + - user + /users/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: user_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/user_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - user + /users/{id}/reset-credentials: + post: + description: 执行操作ResetCredentials + operationId: user_PerformResetCredentials + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + $ref: '#/definitions/ResetCredentialInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformResetCredentialsOutput' + summary: 用户加入项目 + tags: + - user + /users/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: user_PerformSetClassMetadata + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - user + /users/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: user_PerformSetUserMetadata + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - user + /users/{id}/unlink-idp: + post: + description: 执行操作UnlinkIdp + operationId: user_PerformUnlinkIdp + parameters: + - description: The Id or Name of user + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + user: + $ref: '#/definitions/UserUnlinkIdpInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformUnlinkIdpOutput' + summary: 用户和IDP的指定entityId解除关联 + tags: + - user + /users/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: user_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/user_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - user + /users/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: user_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/user_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - user + /users/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: user_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/user_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - user + /users/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: user_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + user: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/user_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - user + /users/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: user_GetPropertySplitable + responses: + "200": + $ref: '#/responses/user_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - user + /users/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: user_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/user_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - user + /users/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: user_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/user_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - user + /users/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: user_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/user_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - user + /v2.0/tokens: + post: + description: keystone v2 认证接口，通过用户名/密码或者 token 认证 + operationId: tokens_AuthenticateV2 + parameters: + - in: body + name: body + schema: + $ref: '#/definitions/SAuthenticationInputV2' + x-go-name: Body + responses: + "200": + $ref: '#/responses/tokens_AuthenticateV2Output' + summary: keystone v2 认证接口，通过用户名/密码或者 token 认证 + tags: + - authentication + /v2.0/tokens/{token}: + get: + description: keystone v2验证token API + operationId: verifyTokensV2 + parameters: + - description: keystone V2验证token + in: path + name: Token + required: true + type: string + responses: + "200": + $ref: '#/responses/tokens_AuthenticateV2Output' + summary: keystone v2验证token API + tags: + - authentication + /v3/auth/tokens: + get: + description: keystone v3验证token API + operationId: verifyTokensV3 + parameters: + - description: keystone V3验证token + in: header + name: X-Subject-Token + required: true + type: string + x-go-name: Token + responses: + "200": + $ref: '#/responses/tokens_AuthenticateV3Output' + summary: keystone v3验证token API + tags: + - authentication + post: + description: keystone v3认证API + operationId: tokens_AuthenticateV3 + parameters: + - in: body + name: body + schema: + $ref: '#/definitions/SAuthenticationInputV3' + x-go-name: Body + responses: + "200": + $ref: '#/responses/tokens_AuthenticateV3Output' + summary: keystone v3认证API + tags: + - authentication +produces: +- application/json +responses: + credential_CustomizeDeleteOutput: + schema: + properties: + credential: + $ref: '#/definitions/CredentialDetails' + type: object + credential_FetchCustomizeColumnsOutput: + schema: + properties: + credential: + $ref: '#/definitions/CredentialDetails' + type: object + credential_GetDetailsClassMetadataOutput: + schema: + properties: + credential: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + credential_GetDetailsMetadataOutput: + schema: + properties: + credential: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + credential_GetPropertyDistinctFieldOutput: {} + credential_GetPropertySplitableExportOutput: {} + credential_GetPropertySplitableOutput: {} + credential_GetPropertyTagValuePairsOutput: {} + credential_GetPropertyTagValueTreeOutput: {} + credential_ListItemFilterOutput: + schema: + properties: + credentials: + items: + $ref: '#/definitions/CredentialDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + credential_PerformClassMetadataOutput: {} + credential_PerformPurgeSplitableOutput: {} + credential_PerformSetClassMetadataOutput: {} + credential_PerformSetUserMetadataOutput: {} + credential_ValidateCreateDataOutput: + schema: + properties: + credential: + $ref: '#/definitions/CredentialDetails' + type: object + credential_ValidateUpdateDataOutput: + schema: + properties: + credential: + $ref: '#/definitions/CredentialDetails' + type: object + domain_CustomizeDeleteOutput: + schema: + properties: + domain: + $ref: '#/definitions/DomainDetails' + type: object + domain_FetchCustomizeColumnsOutput: + schema: + properties: + domain: + $ref: '#/definitions/DomainDetails' + type: object + domain_GetDetailsClassMetadataOutput: + schema: + properties: + domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + domain_GetDetailsMetadataOutput: + schema: + properties: + domain: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + domain_GetPropertyDistinctFieldOutput: {} + domain_GetPropertySplitableExportOutput: {} + domain_GetPropertySplitableOutput: {} + domain_GetPropertyTagValuePairsOutput: {} + domain_GetPropertyTagValueTreeOutput: {} + domain_ListItemFilterOutput: + schema: + properties: + domains: + items: + $ref: '#/definitions/DomainDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + domain_PerformClassMetadataOutput: {} + domain_PerformPurgeSplitableOutput: {} + domain_PerformSetClassMetadataOutput: {} + domain_PerformSetUserMetadataOutput: {} + domain_PerformUnlinkIdpOutput: {} + domain_ValidateCreateDataOutput: + schema: + properties: + domain: + $ref: '#/definitions/DomainDetails' + type: object + domain_ValidateUpdateDataOutput: + schema: + properties: + domain: + $ref: '#/definitions/DomainDetails' + type: object + endpoint_CustomizeDeleteOutput: + schema: + properties: + endpoint: + $ref: '#/definitions/EndpointDetails' + type: object + endpoint_FetchCustomizeColumnsOutput: + schema: + properties: + endpoint: + $ref: '#/definitions/EndpointDetails' + type: object + endpoint_GetDetailsClassMetadataOutput: + schema: + properties: + endpoint: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + endpoint_GetDetailsMetadataOutput: + schema: + properties: + endpoint: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + endpoint_GetPropertyDistinctFieldOutput: {} + endpoint_GetPropertySplitableExportOutput: {} + endpoint_GetPropertySplitableOutput: {} + endpoint_GetPropertyTagValuePairsOutput: {} + endpoint_GetPropertyTagValueTreeOutput: {} + endpoint_ListItemFilterOutput: + schema: + properties: + endpoints: + items: + $ref: '#/definitions/EndpointDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + endpoint_PerformClassMetadataOutput: {} + endpoint_PerformPurgeSplitableOutput: {} + endpoint_PerformSetClassMetadataOutput: {} + endpoint_PerformSetUserMetadataOutput: {} + endpoint_ValidateCreateDataOutput: + schema: + properties: + endpoint: + $ref: '#/definitions/EndpointDetails' + type: object + endpoint_ValidateUpdateDataOutput: + schema: + properties: + endpoint: + $ref: '#/definitions/EndpointDetails' + type: object + group_CustomizeDeleteOutput: + schema: + properties: + group: + $ref: '#/definitions/GroupDetails' + type: object + group_FetchCustomizeColumnsOutput: + schema: + properties: + group: + $ref: '#/definitions/GroupDetails' + type: object + group_GetDetailsClassMetadataOutput: + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetDetailsMetadataOutput: + schema: + properties: + group: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + group_GetPropertyDistinctFieldOutput: {} + group_GetPropertyDomainTagValuePairsOutput: {} + group_GetPropertyDomainTagValueTreeOutput: {} + group_GetPropertySplitableExportOutput: {} + group_GetPropertySplitableOutput: {} + group_GetPropertyTagValuePairsOutput: {} + group_GetPropertyTagValueTreeOutput: {} + group_ListItemFilterOutput: + schema: + properties: + groups: + items: + $ref: '#/definitions/GroupDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + group_PerformAddUsersOutput: {} + group_PerformClassMetadataOutput: {} + group_PerformJoinOutput: {} + group_PerformLeaveOutput: {} + group_PerformPurgeSplitableOutput: {} + group_PerformRemoveUsersOutput: {} + group_PerformSetClassMetadataOutput: {} + group_PerformSetUserMetadataOutput: {} + group_ValidateCreateDataOutput: + schema: + properties: + group: + $ref: '#/definitions/GroupDetails' + type: object + group_ValidateUpdateDataOutput: + schema: + properties: + group: + $ref: '#/definitions/GroupDetails' + type: object + identity_provider_CustomizeDeleteOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderDetails' + type: object + identity_provider_FetchCustomizeColumnsOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderDetails' + type: object + identity_provider_GetDetailsClassMetadataOutput: + schema: + properties: + identity_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + identity_provider_GetDetailsConfigOutput: {} + identity_provider_GetDetailsMetadataOutput: + schema: + properties: + identity_provider: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + identity_provider_GetDetailsSamlMetadataOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/GetIdpSamlMetadataOutput' + type: object + identity_provider_GetDetailsSsoCallbackUriOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/GetIdpSsoCallbackUriOutput' + type: object + identity_provider_GetDetailsSsoRedirectUriOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/GetIdpSsoRedirectUriOutput' + type: object + identity_provider_GetDetailsStatusOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + identity_provider_GetPropertyDistinctFieldOutput: {} + identity_provider_GetPropertySplitableExportOutput: {} + identity_provider_GetPropertySplitableOutput: {} + identity_provider_GetPropertyStatisticsOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/StatusStatistic' + type: object + identity_provider_GetPropertyTagValuePairsOutput: {} + identity_provider_GetPropertyTagValueTreeOutput: {} + identity_provider_ListItemFilterOutput: + schema: + properties: + identity_providers: + items: + $ref: '#/definitions/IdentityProviderDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + identity_provider_PerformClassMetadataOutput: {} + identity_provider_PerformConfigOutput: {} + identity_provider_PerformDefaultSsoOutput: {} + identity_provider_PerformDisableOutput: {} + identity_provider_PerformEnableOutput: {} + identity_provider_PerformPurgeSplitableOutput: {} + identity_provider_PerformSetClassMetadataOutput: {} + identity_provider_PerformSetUserMetadataOutput: {} + identity_provider_PerformStatusOutput: {} + identity_provider_PerformSyncOutput: {} + identity_provider_ValidateCreateDataOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderDetails' + type: object + identity_provider_ValidateUpdateDataOutput: + schema: + properties: + identity_provider: + $ref: '#/definitions/IdentityProviderDetails' + type: object + models_GetIdentityQuotaOutput: + schema: + properties: + identity_quotas: + items: + $ref: '#/definitions/SIdentityQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListIdentityQuotasOutput: + schema: + properties: + identity_quotas: + items: + $ref: '#/definitions/SIdentityQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetIdentityQuotasOutput: + schema: + properties: + identity_quotas: + items: + $ref: '#/definitions/SIdentityQuotaDetail' + type: array + x-go-name: Output + type: object + policy_CustomizeDeleteOutput: + schema: + properties: + policy: + $ref: '#/definitions/PolicyDetails' + type: object + policy_FetchCustomizeColumnsOutput: + schema: + properties: + policy: + $ref: '#/definitions/PolicyDetails' + type: object + policy_GetDetailsClassMetadataOutput: + schema: + properties: + policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_GetDetailsMetadataOutput: + schema: + properties: + policy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + policy_GetPropertyDistinctFieldOutput: {} + policy_GetPropertyDomainTagValuePairsOutput: {} + policy_GetPropertyDomainTagValueTreeOutput: {} + policy_GetPropertySplitableExportOutput: {} + policy_GetPropertySplitableOutput: {} + policy_GetPropertyTagValuePairsOutput: {} + policy_GetPropertyTagValueTreeOutput: {} + policy_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + policies: + items: + $ref: '#/definitions/PolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + policy_PerformBindRoleOutput: {} + policy_PerformClassMetadataOutput: {} + policy_PerformPrivateOutput: {} + policy_PerformPublicOutput: {} + policy_PerformPurgeSplitableOutput: {} + policy_PerformSetClassMetadataOutput: {} + policy_PerformSetUserMetadataOutput: {} + policy_ValidateCreateDataOutput: + schema: + properties: + policy: + $ref: '#/definitions/PolicyDetails' + type: object + policy_ValidateUpdateDataOutput: + schema: + properties: + policy: + $ref: '#/definitions/PolicyDetails' + type: object + project_CustomizeDeleteOutput: + schema: + properties: + project: + $ref: '#/definitions/ProjectDetails' + type: object + project_FetchCustomizeColumnsOutput: + schema: + properties: + project: + $ref: '#/definitions/ProjectDetails' + type: object + project_GetDetailsClassMetadataOutput: + schema: + properties: + project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_GetDetailsMetadataOutput: + schema: + properties: + project: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + project_GetPropertyDistinctFieldOutput: {} + project_GetPropertyDomainTagValuePairsOutput: {} + project_GetPropertyDomainTagValueTreeOutput: {} + project_GetPropertySplitableExportOutput: {} + project_GetPropertySplitableOutput: {} + project_GetPropertyTagValuePairsOutput: {} + project_GetPropertyTagValueTreeOutput: {} + project_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + projects: + items: + $ref: '#/definitions/ProjectDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + project_PerformClassMetadataOutput: {} + project_PerformJoinOutput: {} + project_PerformLeaveOutput: {} + project_PerformPurgeSplitableOutput: {} + project_PerformSetAdminOutput: {} + project_PerformSetClassMetadataOutput: {} + project_PerformSetUserMetadataOutput: {} + project_ValidateCreateDataOutput: + schema: + properties: + project: + $ref: '#/definitions/ProjectDetails' + type: object + project_ValidateUpdateDataOutput: + schema: + properties: + project: + $ref: '#/definitions/ProjectDetails' + type: object + region_CustomizeDeleteOutput: + schema: + properties: + region: + $ref: '#/definitions/RegionDetails' + type: object + region_FetchCustomizeColumnsOutput: + schema: + properties: + region: + $ref: '#/definitions/RegionDetails' + type: object + region_GetDetailsClassMetadataOutput: + schema: + properties: + region: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + region_GetDetailsMetadataOutput: + schema: + properties: + region: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + region_GetPropertyDistinctFieldOutput: {} + region_GetPropertySplitableExportOutput: {} + region_GetPropertySplitableOutput: {} + region_GetPropertyTagValuePairsOutput: {} + region_GetPropertyTagValueTreeOutput: {} + region_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + regions: + items: + $ref: '#/definitions/RegionDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + region_PerformClassMetadataOutput: {} + region_PerformPurgeSplitableOutput: {} + region_PerformSetClassMetadataOutput: {} + region_PerformSetUserMetadataOutput: {} + region_ValidateCreateDataOutput: + schema: + properties: + region: + $ref: '#/definitions/RegionDetails' + type: object + region_ValidateUpdateDataOutput: + schema: + properties: + region: + $ref: '#/definitions/RegionDetails' + type: object + role_CustomizeDeleteOutput: + schema: + properties: + role: + $ref: '#/definitions/RoleDetails' + type: object + role_FetchCustomizeColumnsOutput: + schema: + properties: + role: + $ref: '#/definitions/RoleDetails' + type: object + role_GetDetailsClassMetadataOutput: + schema: + properties: + role: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + role_GetDetailsMetadataOutput: + schema: + properties: + role: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + role_GetPropertyDistinctFieldOutput: {} + role_GetPropertyDomainTagValuePairsOutput: {} + role_GetPropertyDomainTagValueTreeOutput: {} + role_GetPropertySplitableExportOutput: {} + role_GetPropertySplitableOutput: {} + role_GetPropertyTagValuePairsOutput: {} + role_GetPropertyTagValueTreeOutput: {} + role_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + roles: + items: + $ref: '#/definitions/RoleDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + role_PerformAddPolicyOutput: {} + role_PerformClassMetadataOutput: {} + role_PerformPrivateOutput: {} + role_PerformPublicOutput: {} + role_PerformPurgeSplitableOutput: {} + role_PerformRemovePolicyOutput: {} + role_PerformSetClassMetadataOutput: {} + role_PerformSetPoliciesOutput: {} + role_PerformSetUserMetadataOutput: {} + role_ValidateCreateDataOutput: + schema: + properties: + role: + $ref: '#/definitions/RoleDetails' + type: object + role_ValidateUpdateDataOutput: + schema: + properties: + role: + $ref: '#/definitions/RoleDetails' + type: object + role_policy_CustomizeDeleteOutput: + schema: + properties: + role_policy: + $ref: '#/definitions/RolePolicyDetails' + type: object + role_policy_FetchCustomizeColumnsOutput: + schema: + properties: + role_policy: + $ref: '#/definitions/RolePolicyDetails' + type: object + role_policy_GetPropertyDistinctFieldOutput: {} + role_policy_GetPropertySplitableExportOutput: {} + role_policy_GetPropertySplitableOutput: {} + role_policy_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + role_policies: + items: + $ref: '#/definitions/RolePolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + role_policy_PerformPurgeSplitableOutput: {} + role_policy_ValidateCreateDataOutput: + schema: + properties: + role_policy: + $ref: '#/definitions/RolePolicyDetails' + type: object + role_policy_ValidateUpdateDataOutput: + schema: + properties: + role_policy: + $ref: '#/definitions/RolePolicyDetails' + type: object + scope_resource_CustomizeDeleteOutput: + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseDetails' + type: object + scope_resource_FetchCustomizeColumnsOutput: + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseDetails' + type: object + scope_resource_GetPropertyDistinctFieldOutput: {} + scope_resource_GetPropertySplitableExportOutput: {} + scope_resource_GetPropertySplitableOutput: {} + scope_resource_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scope_resources: + items: + $ref: '#/definitions/ModelBaseDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scope_resource_PerformPurgeSplitableOutput: {} + scope_resource_ValidateCreateDataOutput: + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseDetails' + type: object + scope_resource_ValidateUpdateDataOutput: + schema: + properties: + scope_resource: + $ref: '#/definitions/ModelBaseDetails' + type: object + service_CustomizeDeleteOutput: + schema: + properties: + service: + $ref: '#/definitions/ServiceDetails' + type: object + service_FetchCustomizeColumnsOutput: + schema: + properties: + service: + $ref: '#/definitions/ServiceDetails' + type: object + service_GetDetailsClassMetadataOutput: + schema: + properties: + service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_GetDetailsConfigOutput: {} + service_GetDetailsMetadataOutput: + schema: + properties: + service: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_GetPropertyDistinctFieldOutput: {} + service_GetPropertySplitableExportOutput: {} + service_GetPropertySplitableOutput: {} + service_GetPropertyTagValuePairsOutput: {} + service_GetPropertyTagValueTreeOutput: {} + service_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + services: + items: + $ref: '#/definitions/ServiceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + service_PerformClassMetadataOutput: {} + service_PerformConfigOutput: {} + service_PerformPurgeSplitableOutput: {} + service_PerformSetClassMetadataOutput: {} + service_PerformSetUserMetadataOutput: {} + service_ValidateCreateDataOutput: + schema: + properties: + service: + $ref: '#/definitions/ServiceDetails' + type: object + service_ValidateUpdateDataOutput: + schema: + properties: + service: + $ref: '#/definitions/ServiceDetails' + type: object + service_certificate_CustomizeDeleteOutput: + schema: + properties: + service_certificate: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + service_certificate_FetchCustomizeColumnsOutput: + schema: + properties: + service_certificate: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + service_certificate_GetDetailsClassMetadataOutput: + schema: + properties: + service_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_certificate_GetDetailsMetadataOutput: + schema: + properties: + service_certificate: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + service_certificate_GetPropertyDistinctFieldOutput: {} + service_certificate_GetPropertySplitableExportOutput: {} + service_certificate_GetPropertySplitableOutput: {} + service_certificate_GetPropertyTagValuePairsOutput: {} + service_certificate_GetPropertyTagValueTreeOutput: {} + service_certificate_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + service_certificates: + items: + $ref: '#/definitions/StandaloneResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + service_certificate_PerformClassMetadataOutput: {} + service_certificate_PerformPurgeSplitableOutput: {} + service_certificate_PerformSetClassMetadataOutput: {} + service_certificate_PerformSetUserMetadataOutput: {} + service_certificate_ValidateCreateDataOutput: + schema: + properties: + service_certificate: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + service_certificate_ValidateUpdateDataOutput: + schema: + properties: + service_certificate: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + tokens_AuthenticateV2Output: + schema: + $ref: '#/definitions/SAuthenticateV2ResponseBody' + tokens_AuthenticateV3Output: + headers: + X-Subject-Token: + description: |- + 验证成功的keystone V3 token + in:header + type: string + schema: + $ref: '#/definitions/TokenCredentialV3' + user_CustomizeDeleteOutput: + schema: + properties: + user: + $ref: '#/definitions/UserDetails' + type: object + user_FetchCustomizeColumnsOutput: + schema: + properties: + user: + $ref: '#/definitions/UserDetails' + type: object + user_GetDetailsClassMetadataOutput: + schema: + properties: + user: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + user_GetDetailsMetadataOutput: + schema: + properties: + user: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + user_GetPropertyDistinctFieldOutput: {} + user_GetPropertyDomainTagValuePairsOutput: {} + user_GetPropertyDomainTagValueTreeOutput: {} + user_GetPropertySplitableExportOutput: {} + user_GetPropertySplitableOutput: {} + user_GetPropertyTagValuePairsOutput: {} + user_GetPropertyTagValueTreeOutput: {} + user_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + users: + items: + $ref: '#/definitions/UserDetails' + type: array + x-go-name: Output + type: object + user_PerformClassMetadataOutput: {} + user_PerformJoinOutput: {} + user_PerformLeaveOutput: {} + user_PerformLinkIdpOutput: {} + user_PerformPurgeSplitableOutput: {} + user_PerformResetCredentialsOutput: {} + user_PerformSetClassMetadataOutput: {} + user_PerformSetUserMetadataOutput: {} + user_PerformUnlinkIdpOutput: {} + user_ValidateCreateDataOutput: + schema: + properties: + user: + $ref: '#/definitions/UserDetails' + type: object + user_ValidateUpdateDataOutput: + schema: + properties: + user: + $ref: '#/definitions/UserDetails' + type: object +schemes: +- https +- http +securityDefinitions: + keystone: + in: header + name: X-Auth-Token + type: apiKey +swagger: "2.0" diff --git a/docs/swagger/swagger_image.yaml b/docs/swagger/swagger_image.yaml new file mode 100644 index 0000000000..93ab88b13c --- /dev/null +++ b/docs/swagger/swagger_image.yaml @@ -0,0 +1,3365 @@ +basePath: / +consumes: +- application/json +definitions: + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + GuestImageCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_format: + description: 镜像格式 + type: string + x-go-name: DiskFormat + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + images: + description: 镜像列表 + items: + $ref: '#/definitions/GuestImageCreateInputSubimage' + type: array + x-go-name: Images + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + notes: + description: 备注 + type: string + x-go-name: Notes + os_arch: + description: CPU架构 x86_64 or aarch64 + type: string + x-go-name: OsArch + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + properties: + additionalProperties: + type: string + description: 镜像属性 + type: object + x-go-name: Properties + protected: + description: 是否有删除保护 + type: boolean + x-go-name: Protected + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + size: + description: 镜像大小, 单位Byte + format: int64 + type: integer + x-go-name: Size + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + GuestImageCreateInputSubimage: + properties: + disk_format: + description: 磁盘格式 + type: string + x-go-name: DiskFormat + id: + description: Id + type: string + x-go-name: Id + virtual_size: + description: 磁盘大小 + format: int64 + type: integer + x-go-name: VirtualSize + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + GuestImageDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + data_images: + items: + $ref: '#/definitions/SubImageInfo' + type: array + x-go-name: DataImages + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + type: boolean + x-go-name: DisableDelete + disk_format: + type: string + x-go-name: DiskFormat + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + min_ram_mb: + format: int32 + type: integer + x-go-name: MinRamMb + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + properties: + type: object + x-go-name: Properties + protected: + type: boolean + x-go-name: Protected + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + root_image: + $ref: '#/definitions/SubImageInfo' + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + size: + description: Status string `json:"status"` + format: int64 + type: integer + x-go-name: Size + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + ImageCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disk_format: + description: 镜像格式 + type: string + x-go-name: DiskFormat + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + encrypt_key_alg: + description: 新建密钥算法 + type: string + x-go-name: EncryptKeyAlg + encrypt_key_id: + description: 加密密钥的ID + type: string + x-go-name: EncryptKeyId + encrypt_key_new: + description: 是否新建密钥 + type: boolean + x-go-name: EncryptKeyNew + encrypt_key_user_id: + description: 加密密钥的用户ID + type: string + x-go-name: EncryptKeyUserId + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_data: + description: 是否是数据盘镜像 + type: boolean + x-go-name: IsData + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_guest_image: + description: 是否是主机镜像 + type: boolean + x-go-name: IsGuestImage + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_standard: + description: 是否是标准镜像 + type: boolean + x-go-name: IsStandard + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + min_disk: + description: 最小系统盘要求 + format: int32 + type: integer + x-go-name: MinDiskMB + min_ram: + description: 最小内存要求 + format: int32 + type: integer + x-go-name: MinRamMB + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + properties: + additionalProperties: + type: string + description: 镜像属性 + type: object + x-go-name: Properties + protected: + description: 是否有删除保护 + type: boolean + x-go-name: Protected + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + size: + description: 镜像大小, 单位Byte + format: int64 + type: integer + x-go-name: Size + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + ImageDetails: + properties: + auto_delete_at: + description: 自动清除时间 + format: date-time + type: string + x-go-name: AutoDeleteAt + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + checksum: + description: 校验和 + type: string + x-go-name: Checksum + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + disable_delete: + description: 删除保护 + type: boolean + x-go-name: DisableDelete + disk_format: + description: 镜像格式 + type: string + x-go-name: DiskFormat + domain_id: + description: 域Id + type: string + x-go-name: DomainId + encrypt_alg: + description: 加密算法，aes-256 or sm4 + type: string + x-go-name: EncryptAlg + encrypt_key: + description: 秘钥名称 + type: string + x-go-name: EncryptKey + encrypt_key_id: + description: 加密密钥ID + type: string + x-go-name: EncryptKeyId + encrypt_key_user: + description: 密钥用户 + type: string + x-go-name: EncryptKeyUser + encrypt_key_user_domain: + description: 密钥用户域 + type: string + x-go-name: EncryptKeyUserDomain + encrypt_key_user_domain_id: + description: 密钥用户域ID + type: string + x-go-name: EncryptKeyUserDomainId + encrypt_key_user_id: + description: 密钥用户ID + type: string + x-go-name: EncryptKeyUserId + encrypt_status: + description: 加密状态, "",encrypting,encrypted + type: string + x-go-name: EncryptStatus + fast_hash: + type: string + x-go-name: FastHash + freezed: + description: 资源是否被冻结 + type: boolean + x-go-name: Freezed + id: + description: 资源UUID + type: string + x-go-name: Id + is_data: + description: 是否是数据盘镜像 + type: boolean + x-go-name: IsData + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_guest_image: + description: 是否是主机镜像 + type: boolean + x-go-name: IsGuestImage + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_standard: + description: 是否是标准镜像 + type: boolean + x-go-name: IsStandard + is_system: + description: 是否是系统资源 + type: boolean + x-go-name: IsSystem + location: + description: 存储地址 + type: string + x-go-name: Location + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + min_disk: + description: 最小系统盘要求 + format: int32 + type: integer + x-go-name: MinDiskMB + min_ram: + description: 最小内存要求 + format: int32 + type: integer + x-go-name: MinRamMB + name: + description: 资源名称 + type: string + x-go-name: Name + os_arch: + description: 操作系统 CPU 架构 + example: x86 arm + type: string + x-go-name: OsArch + oss_checksum: + description: |- + image copy from url, save origin checksum before probe + 从镜像时长导入的镜像校验和 + type: string + x-go-name: OssChecksum + owner: + description: 用户Id + type: string + x-go-name: Owner + pending_deleted: + description: 资源是否处于回收站中 + type: boolean + x-go-name: PendingDeleted + pending_deleted_at: + description: 资源放入回收站时间 + format: date-time + type: string + x-go-name: PendingDeletedAt + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + project_src: + description: '云上同步资源是否在本地被更改过配置, local: 更改过, cloud: 未更改过' + example: local + type: string + x-go-name: ProjectSrc + properties: + additionalProperties: + type: string + description: 镜像属性信息 + type: object + x-go-name: Properties + protected: + description: 是否有删除保护 + type: boolean + x-go-name: Protected + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + size: + description: 镜像大小, 单位Byte + format: int64 + type: integer + x-go-name: Size + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + ImageUpdateStatusInput: + properties: + reason: + description: 更新镜像状态原因 + type: string + x-go-name: Reason + status: + description: 镜像状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + PerformChangeProjectOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformFreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformProbeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + PerformPublicProjectInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + shared_project_ids: + description: 如果共享范围为项目，则在此列表中指定共享的目标项目 + items: + type: string + type: array + x-go-name: SharedProjectIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformUnfreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProjectStatistic: + properties: + Count: + format: int64 + type: integer + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SImageQuotaDetail: + description: 区域配额详情 + properties: + Image: + format: int64 + type: integer + Type: + type: string + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain: + description: 配额适用的项目的域名称 + type: string + x-go-name: Domain + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + project: + description: 配额适用的项目名称 + type: string + x-go-name: Project + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/image/models + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + SetImageQuotaInput: + description: 设置镜像配额输入参数 + properties: + Image: + format: int64 + type: integer + Type: + type: string + action: + description: |- + 设置配额操作 + + action | 说明 | + ---------|-------------------------------------------| + add | 增量增加配额 | + sub | 增量减少配额 | + reset | 重置所有配额为0 | + replace | 替换所有配额，对于不存在的配额项，设置为0 | + update | 更新存在的配额 | + delete | 删除配额 | + type: string + x-go-name: Action + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain_id: + description: 配额适用的域ID + type: string + x-go-name: DomainId + project_id: + description: 配额适用的项目ID + type: string + x-go-name: ProjectId + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/image/models + SharableVirtualResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedDomain: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedProject: + properties: + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SubImageInfo: + properties: + created_at: + format: date-time + type: string + x-go-name: CreatedAt + disable_delete: + type: boolean + x-go-name: DisableDelete + disk_format: + type: string + x-go-name: DiskFormat + encrypt_key_id: + type: string + x-go-name: EncryptKeyId + id: + type: string + x-go-name: ID + min_disk_mb: + format: int32 + type: integer + x-go-name: MinDiskMB + name: + type: string + x-go-name: Name + size: + format: int64 + type: integer + x-go-name: Size + status: + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/image + TTagSet: + items: + $ref: '#/definitions/STag' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils +host: '"127.0.0.1:8889"' +info: + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Image API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" +paths: + /guest_images: + get: + description: 列表 + operationId: guest_image_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 是否删除保护 + in: query + name: protected + type: boolean + x-go-name: Protected + responses: + "200": + $ref: '#/responses/guest_image_ListItemFilterOutput' + summary: 主机镜像列表 + tags: + - guest_image + post: + description: 新建 + operationId: guest_image_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + guest_image: + $ref: '#/definitions/GuestImageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_ValidateCreateDataOutput' + summary: 新建 + tags: + - guest_image + /guest_images/{id}: + delete: + description: 删除 + operationId: guest_image_CustomizeDelete + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_CustomizeDeleteOutput' + summary: 删除 + tags: + - guest_image + get: + description: 获取详情 + operationId: guest_image_FetchCustomizeColumns + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - guest_image + put: + description: 更新 + operationId: guest_image_ValidateUpdateData + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/SharableVirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_ValidateUpdateDataOutput' + summary: 更新 + tags: + - guest_image + /guest_images/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: guest_image_PerformCancelDelete + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - guest_image + /guest_images/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: guest_image_PerformChangeOwner + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - guest_image + /guest_images/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: guest_image_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - guest_image + /guest_images/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: guest_image_GetDetailsClassMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - guest_image + post: + description: 执行操作ClassMetadata + operationId: guest_image_PerformClassMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - guest_image + /guest_images/{id}/freeze: + post: + description: 执行操作Freeze + operationId: guest_image_PerformFreeze + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - guest_image + /guest_images/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: guest_image_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - guest_image + /guest_images/{id}/private: + post: + description: 执行操作Private + operationId: guest_image_PerformPrivate + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformPrivateOutput' + summary: 执行操作Private + tags: + - guest_image + /guest_images/{id}/public: + post: + description: 执行操作Public + operationId: guest_image_PerformPublic + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformPublicOutput' + summary: 执行操作Public + tags: + - guest_image + /guest_images/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: guest_image_PerformSetClassMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformSetClassMetadataOutput' + summary: 执行操作SetClassMetadata + tags: + - guest_image + /guest_images/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: guest_image_PerformSetUserMetadata + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - guest_image + /guest_images/{id}/status: + get: + description: 获取指定信息Status + operationId: guest_image_GetDetailsStatus + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/guest_image_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - guest_image + post: + description: 执行操作Status + operationId: guest_image_PerformStatus + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformStatusOutput' + summary: 更新资源状态 + tags: + - guest_image + /guest_images/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: guest_image_PerformUnfreeze + parameters: + - description: The Id or Name of guest_image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - guest_image + /guest_images/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: guest_image_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - guest_image + /guest_images/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: guest_image_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - guest_image + /guest_images/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: guest_image_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - guest_image + /guest_images/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: guest_image_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - guest_image + /guest_images/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: guest_image_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - guest_image + /guest_images/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: guest_image_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + guest_image: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/guest_image_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - guest_image + /guest_images/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: guest_image_GetPropertySplitable + responses: + "200": + $ref: '#/responses/guest_image_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - guest_image + /guest_images/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: guest_image_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/guest_image_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - guest_image + /guest_images/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: guest_image_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - guest_image + /guest_images/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: guest_image_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - guest_image + /guest_images/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: guest_image_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/guest_image_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - guest_image + /image_quotas/{scope}: + get: + description: 获取所有项目或者域的镜像配额 + operationId: models_ListImageQuotas + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 配额所属范围，可能值为projects和domains，分别代表项 目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_ListImageQuotasOutput' + summary: 获取所有项目或者域的镜像配额 + tags: + - image_quota + /image_quotas/{scope}/{scopeId}: + get: + description: 获取指定项目或者域的镜像配额 + operationId: models_GetImageQuota + parameters: + - description: |- + 只列出主配额 + require:false + in: query + name: primary + type: boolean + x-go-name: Primary + - description: |- + 强制刷新使用量 + require:false + in: query + name: refresh + type: boolean + x-go-name: Refresh + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/models_GetImageQuotaOutput' + summary: 获取指定项目或者域的镜像配额 + tags: + - image_quota + post: + description: 设置指定项目或者域的镜像配额 + operationId: models_SetRegionQuotas + parameters: + - description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额 + in: path + name: scope + required: true + type: string + x-go-name: Scope + - description: 指定项目或者域的ID + in: path + name: scopeId + required: true + type: string + x-go-name: ScopeId + - in: body + name: body + schema: + properties: + image_quotas: + $ref: '#/definitions/SetImageQuotaInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/models_SetRegionQuotasOutput' + summary: 设置指定项目或者域的镜像配额 + tags: + - image_quota + /images: + get: + description: 列表 + operationId: image_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: |- + 通过操作系统架构过滤 + x86会过滤出os_arch为空或os_arch=i386或以x86开头的资源 + arm会过滤出os_arch=aarch64或os_arch=aarch32或者以arm开头的资源 + 其他的输入会过滤出以输入字符开头的资源 + enmu: x86, arm + in: query + name: os_arch + type: string + x-go-name: OsArch + - description: 以镜像的格式过滤，可能值为：qcow2, iso, vmdk, vhd, raw等 + in: query + items: + type: string + name: disk_formats + type: array + x-go-name: DiskFormats + - description: 列出是否支持UEFI启动的镜像 + in: query + name: uefi + type: boolean + x-go-name: Uefi + - description: '根据已转换格式过滤, 可能值为: qcow2, vmdk, vhd, raw等' + in: query + items: + type: string + name: subFormats + type: array + x-go-name: SubFormats + - description: 是否为标准镜像 + in: query + name: is_standard + type: boolean + x-go-name: IsStandard + - description: 是否删除保护 + in: query + name: protected + type: boolean + x-go-name: Protected + - description: 是否为主机镜像的子镜像 + in: query + name: is_guest_image + type: boolean + x-go-name: IsGuestImage + - description: 是否为数据盘 + in: query + name: is_data + type: boolean + x-go-name: IsData + - description: '操作系统类型，可能值为: Linux, Windows, FreeBSD 等' + in: query + items: + type: string + name: os_types + type: array + x-go-name: OsTypes + - description: 操作系统精确匹配 + in: query + name: os_type_precise_match + type: boolean + x-go-name: OsTypePreciseMatch + - description: '操作系统架构, 可能值为: arm, x86 等' + in: query + items: + type: string + name: os_archs + type: array + x-go-name: OsArchs + - description: 操作系统架构精确匹配 + in: query + name: os_arch_precise_match + type: boolean + x-go-name: OsArchPreciseMatch + - description: '发行版本，可能值为: CentOS, Ubuntu, Debian, ArchLinux, OpenEuler 等' + in: query + items: + type: string + name: distributions + type: array + x-go-name: Distributions + - description: 发行版精确匹配 + in: query + name: DistributionPreciseMatch + type: boolean + responses: + "200": + $ref: '#/responses/image_ListItemFilterOutput' + summary: 磁盘镜像列表 + tags: + - image + post: + description: 新建 + operationId: image_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + image: + $ref: '#/definitions/ImageCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_ValidateCreateDataOutput' + summary: 新建 + tags: + - image + /images/{id}: + delete: + description: 删除 + operationId: image_CustomizeDelete + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_CustomizeDeleteOutput' + summary: 删除 + tags: + - image + get: + description: 获取详情 + operationId: image_FetchCustomizeColumns + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - image + put: + description: 更新 + operationId: image_ValidateUpdateData + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_ValidateUpdateDataOutput' + summary: 更新 + tags: + - image + /images/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: image_PerformCancelDelete + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - image + /images/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: image_PerformChangeOwner + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - image + /images/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: image_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - image + /images/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: image_GetDetailsClassMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - image + post: + description: 执行操作ClassMetadata + operationId: image_PerformClassMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - image + /images/{id}/freeze: + post: + description: 执行操作Freeze + operationId: image_PerformFreeze + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - image + /images/{id}/mark-standard: + post: + description: 执行操作MarkStandard + operationId: image_PerformMarkStandard + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_PerformMarkStandardOutput' + summary: 执行操作MarkStandard + tags: + - image + /images/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: image_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - image + /images/{id}/private: + post: + description: 执行操作Private + operationId: image_PerformPrivate + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformPrivateOutput' + summary: 执行操作Private + tags: + - image + /images/{id}/probe: + post: + description: 执行操作Probe + operationId: image_PerformProbe + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformProbeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformProbeOutput' + summary: 执行操作Probe + tags: + - image + /images/{id}/public: + post: + description: 执行操作Public + operationId: image_PerformPublic + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformPublicOutput' + summary: 执行操作Public + tags: + - image + /images/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: image_PerformSetClassMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformSetClassMetadataOutput' + summary: 执行操作SetClassMetadata + tags: + - image + /images/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: image_PerformSetUserMetadata + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - image + /images/{id}/status: + get: + description: 获取指定信息Status + operationId: image_GetDetailsStatus + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - image + post: + description: 执行操作Status + operationId: image_PerformStatus + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformStatusOutput' + summary: 更新资源状态 + tags: + - image + /images/{id}/subformats: + get: + description: 获取指定信息Subformats + operationId: image_GetDetailsSubformats + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_GetDetailsSubformatsOutput' + summary: 获取指定信息Subformats + tags: + - image + /images/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: image_PerformUnfreeze + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - image + /images/{id}/update-status: + post: + description: 执行操作UpdateStatus + operationId: image_PerformUpdateStatus + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/ImageUpdateStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformUpdateStatusOutput' + summary: 执行操作UpdateStatus + tags: + - image + /images/{id}/update-torrent-status: + post: + description: 执行操作UpdateTorrentStatus + operationId: image_PerformUpdateTorrentStatus + parameters: + - description: The Id or Name of image + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/image_PerformUpdateTorrentStatusOutput' + summary: 执行操作UpdateTorrentStatus + tags: + - image + /images/detail: + get: + description: 获取指定资源类的信息Detail + operationId: image_GetPropertyDetail + responses: + "200": + $ref: '#/responses/image_GetPropertyDetailOutput' + summary: 获取指定资源类的信息Detail + tags: + - image + /images/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: image_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/image_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - image + /images/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: image_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/image_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - image + /images/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: image_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/image_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - image + /images/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: image_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/image_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - image + /images/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: image_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/image_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - image + /images/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: image_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + image: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/image_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - image + /images/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: image_GetPropertySplitable + responses: + "200": + $ref: '#/responses/image_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - image + /images/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: image_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/image_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - image + /images/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: image_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/image_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - image + /images/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: image_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/image_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - image + /images/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: image_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/image_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - image +produces: +- application/json +responses: + guest_image_CustomizeDeleteOutput: + schema: + properties: + guest_image: + $ref: '#/definitions/GuestImageDetails' + type: object + guest_image_FetchCustomizeColumnsOutput: + schema: + properties: + guest_image: + $ref: '#/definitions/GuestImageDetails' + type: object + guest_image_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + guest_image: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + guest_image_GetDetailsClassMetadataOutput: + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_image_GetDetailsMetadataOutput: + schema: + properties: + guest_image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + guest_image_GetDetailsStatusOutput: + schema: + properties: + guest_image: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + guest_image_GetPropertyDistinctFieldOutput: {} + guest_image_GetPropertyDomainStatisticsOutput: + schema: + properties: + guest_image: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + guest_image_GetPropertyProjectStatisticsOutput: + schema: + properties: + guest_image: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + guest_image_GetPropertyProjectTagValuePairsOutput: {} + guest_image_GetPropertyProjectTagValueTreeOutput: {} + guest_image_GetPropertySplitableExportOutput: {} + guest_image_GetPropertySplitableOutput: {} + guest_image_GetPropertyStatisticsOutput: + schema: + properties: + guest_image: + $ref: '#/definitions/StatusStatistic' + type: object + guest_image_GetPropertyTagValuePairsOutput: {} + guest_image_GetPropertyTagValueTreeOutput: {} + guest_image_ListItemFilterOutput: + schema: + properties: + guest_images: + items: + $ref: '#/definitions/GuestImageDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + guest_image_PerformCancelDeleteOutput: {} + guest_image_PerformChangeOwnerOutput: {} + guest_image_PerformClassMetadataOutput: {} + guest_image_PerformFreezeOutput: {} + guest_image_PerformPrivateOutput: {} + guest_image_PerformPublicOutput: {} + guest_image_PerformPurgeSplitableOutput: {} + guest_image_PerformSetClassMetadataOutput: {} + guest_image_PerformSetUserMetadataOutput: {} + guest_image_PerformStatusOutput: {} + guest_image_PerformUnfreezeOutput: {} + guest_image_ValidateCreateDataOutput: + schema: + properties: + guest_image: + $ref: '#/definitions/GuestImageDetails' + type: object + guest_image_ValidateUpdateDataOutput: + schema: + properties: + guest_image: + $ref: '#/definitions/GuestImageDetails' + type: object + image_CustomizeDeleteOutput: + schema: + properties: + image: + $ref: '#/definitions/ImageDetails' + type: object + image_FetchCustomizeColumnsOutput: + schema: + properties: + image: + $ref: '#/definitions/ImageDetails' + type: object + image_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + image: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + image_GetDetailsClassMetadataOutput: + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + image_GetDetailsMetadataOutput: + schema: + properties: + image: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + image_GetDetailsStatusOutput: + schema: + properties: + image: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + image_GetDetailsSubformatsOutput: {} + image_GetPropertyDetailOutput: {} + image_GetPropertyDistinctFieldOutput: {} + image_GetPropertyDomainStatisticsOutput: + schema: + properties: + image: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + image_GetPropertyProjectStatisticsOutput: + schema: + properties: + image: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + image_GetPropertyProjectTagValuePairsOutput: {} + image_GetPropertyProjectTagValueTreeOutput: {} + image_GetPropertySplitableExportOutput: {} + image_GetPropertySplitableOutput: {} + image_GetPropertyStatisticsOutput: + schema: + properties: + image: + $ref: '#/definitions/StatusStatistic' + type: object + image_GetPropertyTagValuePairsOutput: {} + image_GetPropertyTagValueTreeOutput: {} + image_ListItemFilterOutput: + schema: + properties: + images: + items: + $ref: '#/definitions/ImageDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + image_PerformCancelDeleteOutput: {} + image_PerformChangeOwnerOutput: {} + image_PerformClassMetadataOutput: {} + image_PerformFreezeOutput: {} + image_PerformMarkStandardOutput: {} + image_PerformPrivateOutput: {} + image_PerformProbeOutput: {} + image_PerformPublicOutput: {} + image_PerformPurgeSplitableOutput: {} + image_PerformSetClassMetadataOutput: {} + image_PerformSetUserMetadataOutput: {} + image_PerformStatusOutput: {} + image_PerformUnfreezeOutput: {} + image_PerformUpdateStatusOutput: {} + image_PerformUpdateTorrentStatusOutput: {} + image_ValidateCreateDataOutput: + schema: + properties: + image: + $ref: '#/definitions/ImageDetails' + type: object + image_ValidateUpdateDataOutput: + schema: + properties: + image: + $ref: '#/definitions/ImageDetails' + type: object + models_GetImageQuotaOutput: + schema: + properties: + image_quotas: + items: + $ref: '#/definitions/SImageQuotaDetail' + type: array + x-go-name: Output + type: object + models_ListImageQuotasOutput: + schema: + properties: + image_quotas: + items: + $ref: '#/definitions/SImageQuotaDetail' + type: array + x-go-name: Output + type: object + models_SetRegionQuotasOutput: + schema: + properties: + image_quotas: + items: + $ref: '#/definitions/SImageQuotaDetail' + type: array + x-go-name: Output + type: object +schemes: +- https +- http +securityDefinitions: + keystone: + in: header + name: X-Auth-Token + type: apiKey +swagger: "2.0" diff --git a/docs/swagger/swagger_monitor.yaml b/docs/swagger/swagger_monitor.yaml new file mode 100644 index 0000000000..5288d1e925 --- /dev/null +++ b/docs/swagger/swagger_monitor.yaml @@ -0,0 +1,18172 @@ +basePath: / +consumes: +- application/json +definitions: + AlertCloneDashboardInput: + properties: + clone_name: + type: string + x-go-name: CloneName + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertClonePanelInput: + properties: + clone_panel_name: + type: string + x-go-name: ClonePanelName + panel_id: + type: string + x-go-name: PanelId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertCondition: + properties: + evaluator: + $ref: '#/definitions/Condition' + operator: + type: string + x-go-name: Operator + query: + $ref: '#/definitions/AlertQuery' + reducer: + $ref: '#/definitions/Condition' + type: + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertCreateInput: + properties: + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + settings: + $ref: '#/definitions/AlertSetting' + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertDashBoardCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + refresh: + type: string + x-go-name: Refresh + scope: + type: string + x-go-name: Scope + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertDashBoardDetails: + properties: + alert_panel_details: + items: + $ref: '#/definitions/AlertPanelDetail' + type: array + x-go-name: AlertPanelDetails + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertPanelCreateInput: + properties: + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + dashboard_id: + type: string + x-go-name: DashboardId + domain_tags: + $ref: '#/definitions/TTagSetList' + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + from: + type: string + x-go-name: From + interval: + type: string + x-go-name: Interval + level: + description: 报警级别 + type: string + x-go-name: Level + metric_query: + items: + $ref: '#/definitions/CommonAlertQuery' + type: array + x-go-name: MetricQuery + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + no_domain_tags: + $ref: '#/definitions/TTagSetList' + no_project_tags: + $ref: '#/definitions/TTagSetList' + order_by_domain: + description: 按domain名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByDomain + order_by_project: + description: 按project名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByProject + policy_project_tags: + $ref: '#/definitions/TTagSetList' + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_domain_ids: + description: 对具有域属性的资源，严格匹配域ID + items: + type: string + type: array + x-go-name: ProjectDomainIds + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_ids: + description: 对具有项目属性的资源，严格匹配项目ID + items: + type: string + type: array + x-go-name: ProjectIds + project_tags: + $ref: '#/definitions/TTagSetList' + refresh: + type: string + x-go-name: Refresh + scope: + description: 指定查询的权限范围，可能值为project, domain or system + type: string + x-go-name: Scope + settings: + $ref: '#/definitions/AlertSetting' + to: + type: string + x-go-name: To + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertPanelDetail: + properties: + Setting: + type: object + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + common_alert_metric_details: + items: + $ref: '#/definitions/CommonAlertMetricDetails' + type: array + x-go-name: CommonAlertMetricDetails + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + panel_id: + type: string + x-go-name: PanelId + panel_name: + type: string + x-go-name: PanelName + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + refresh: + type: string + x-go-name: Refresh + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertPauseInput: + properties: + paused: + type: boolean + x-go-name: Paused + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertQuery: + properties: + data_source_id: + type: string + x-go-name: DataSourceId + from: + type: string + x-go-name: From + model: + $ref: '#/definitions/MetricQuery' + to: + type: string + x-go-name: To + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + AlertRule: + $ref: '#/definitions/AlertRecordRule' + alert_id: + type: string + x-go-name: AlertId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + eval_data: + items: + $ref: '#/definitions/EvalMatch' + type: array + x-go-name: EvalData + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + level: + description: 报警级别 + type: string + x-go-name: Level + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + res_type: + type: string + x-go-name: ResType + send_state: + type: string + x-go-name: SendState + state: + type: string + x-go-name: State + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordDetails: + properties: + TriggerTime: + format: date-time + type: string + alert_id: + type: string + x-go-name: AlertId + alert_name: + type: string + x-go-name: AlertName + alert_rule: + type: object + x-go-name: AlertRule + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + level: + type: string + x-go-name: Level + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + res_num: + format: int64 + type: integer + x-go-name: ResNum + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + send_state: + type: string + x-go-name: SendState + state: + type: string + x-go-name: State + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordRule: + properties: + alert_duration: + format: int64 + type: integer + x-go-name: AlertDuration + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + condition_type: + type: string + x-go-name: ConditionType + database: + type: string + x-go-name: Database + field: + type: string + x-go-name: Field + field_desc: + type: string + x-go-name: FieldDesc + measurement: + type: string + x-go-name: Measurement + measurement_desc: + type: string + x-go-name: MeasurementDesc + metric: + type: string + x-go-name: Metric + period: + type: string + x-go-name: Period + res_type: + type: string + x-go-name: ResType + silent_period: + description: 静默期 + type: string + x-go-name: SilentPeriod + threshold: + description: 报警阀值 + type: string + x-go-name: Threshold + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordShieldCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + alert_id: + type: string + x-go-name: AlertId + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + end_time: + type: string + x-go-name: EndTime + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + res_id: + type: string + x-go-name: ResId + res_name: + type: string + x-go-name: ResName + res_type: + type: string + x-go-name: ResType + start_time: + type: string + x-go-name: StartTime + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertRecordShieldDetails: + properties: + alert_duration: + description: 报警连续持续周期数 + format: int64 + type: integer + x-go-name: AlertDuration + alert_name: + type: string + x-go-name: AlertName + alert_type: + description: 报警类型 + type: string + x-go-name: AlertType + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + channel: + items: + type: string + type: array + x-go-name: Channel + common_alert_metric_details: + items: + $ref: '#/definitions/CommonAlertMetricDetails' + type: array + x-go-name: CommonAlertMetricDetails + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + expired: + type: boolean + x-go-name: Expired + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + recipients: + items: + type: string + type: array + x-go-name: Recipients + res_name: + type: string + x-go-name: ResName + res_type: + type: string + x-go-name: ResType + robot_ids: + items: + type: string + type: array + x-go-name: RobotIds + role_ids: + items: + type: string + type: array + x-go-name: RoleIds + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + silent_period: + description: 静默期 + type: string + x-go-name: SilentPeriod + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + count: + format: int64 + type: integer + x-go-name: Count + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + tags: + additionalProperties: + type: string + type: object + x-go-name: Tags + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertSetting: + description: AlertSettings contains alert conditions + properties: + conditions: + items: + $ref: '#/definitions/AlertCondition' + type: array + x-go-name: Conditions + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertTestRunInput: + properties: + is_debug: + type: boolean + x-go-name: IsDebug + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertTestRunOutput: + properties: + alert_ok_eval_matches: + items: + $ref: '#/definitions/EvalMatch' + type: array + x-go-name: AlertOKEvalMatches + condition_evals: + type: string + x-go-name: ConditionEvals + end_time: + format: date-time + type: string + x-go-name: EndTime + error: + type: string + x-go-name: Error + eval_matches: + items: + $ref: '#/definitions/EvalMatch' + type: array + x-go-name: EvalMatches + firing: + type: boolean + x-go-name: Firing + is_debug: + type: boolean + x-go-name: IsDebug + is_test_run: + type: boolean + x-go-name: IsTestRun + logs: + items: + $ref: '#/definitions/ResultLogEntry' + type: array + x-go-name: Logs + no_data_found: + type: boolean + x-go-name: NoDataFound + prev_alert_state: + type: string + x-go-name: PrevAlertState + start_time: + format: date-time + type: string + x-go-name: StartTime + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + settings: + $ref: '#/definitions/AlertSetting' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + AlertV1Details: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + channel: + type: string + x-go-name: Channel + comparator: + type: string + x-go-name: Comparator + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + db: + type: string + x-go-name: DB + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + field: + type: string + x-go-name: Field + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + measurement: + type: string + x-go-name: Measurement + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + recipients: + type: string + x-go-name: Recipients + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + threshold: + format: double + type: number + x-go-name: Threshold + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + window: + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + CommonAlertCreateInput: + properties: + alert_duration: + description: 报警连续持续周期数 + format: int64 + type: integer + x-go-name: AlertDuration + alert_type: + description: 报警类型 + type: string + x-go-name: AlertType + channel: + description: '通知方式, 比如: email, mobile' + items: + type: string + type: array + x-go-name: Channel + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + description: + type: string + x-go-name: Description + domain_id: + type: string + x-go-name: DomainId + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + from: + type: string + x-go-name: From + get_point_str: + type: boolean + x-go-name: GetPointStr + interval: + type: string + x-go-name: Interval + level: + description: 报警级别 + type: string + x-go-name: Level + meta_name: + type: string + x-go-name: MetaName + metric_query: + items: + $ref: '#/definitions/CommonAlertQuery' + type: array + x-go-name: MetricQuery + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + period: + description: 查询指标周期 + type: string + x-go-name: Period + project_id: + type: string + x-go-name: ProjectId + recipients: + description: 通知接受者 + items: + type: string + type: array + x-go-name: Recipients + robot_ids: + items: + type: string + type: array + x-go-name: RobotIds + roles: + description: 角色 id 或者 name + items: + type: string + type: array + x-go-name: Roles + scope: + description: Scope Resource + type: string + x-go-name: Scope + settings: + $ref: '#/definitions/AlertSetting' + silent_period: + description: 静默期 + type: string + x-go-name: SilentPeriod + to: + type: string + x-go-name: To + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + CommonAlertDetails: + properties: + alert_duration: + description: 报警连续持续周期数 + format: int64 + type: integer + x-go-name: AlertDuration + alert_type: + description: 报警类型 + type: string + x-go-name: AlertType + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + channel: + items: + type: string + type: array + x-go-name: Channel + common_alert_metric_details: + items: + $ref: '#/definitions/CommonAlertMetricDetails' + type: array + x-go-name: CommonAlertMetricDetails + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + recipients: + items: + type: string + type: array + x-go-name: Recipients + res_type: + type: string + x-go-name: ResType + robot_ids: + items: + type: string + type: array + x-go-name: RobotIds + role_ids: + items: + type: string + type: array + x-go-name: RoleIds + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + silent_period: + description: 静默期 + type: string + x-go-name: SilentPeriod + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + CommonAlertMetricDetails: + properties: + FieldDescription: + $ref: '#/definitions/MetricFieldDetail' + comparator: + type: string + x-go-name: Comparator + condition_type: + type: string + x-go-name: ConditionType + db: + type: string + x-go-name: DB + field: + type: string + x-go-name: Field + field_opt: + type: string + x-go-name: FieldOpt + filters: + items: + $ref: '#/definitions/MetricQueryTag' + type: array + x-go-name: Filters + get_point_str: + type: boolean + x-go-name: GetPointStr + groupby: + type: string + x-go-name: Groupby + measurement: + type: string + x-go-name: Measurement + measurement_display_name: + type: string + x-go-name: MeasurementDisplayName + reduce: + description: metric points'value的运算方式 + type: string + x-go-name: Reduce + res_type: + type: string + x-go-name: ResType + threshold: + format: double + type: number + x-go-name: Threshold + threshold_str: + type: string + x-go-name: ThresholdStr + within_range: + items: + format: double + type: number + type: array + x-go-name: WithinRange + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + CommonAlertQuery: + properties: + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + condition_type: + type: string + x-go-name: ConditionType + data_source_id: + type: string + x-go-name: DataSourceId + field_opt: + description: field yunsuan + type: string + x-go-name: FieldOpt + from: + type: string + x-go-name: From + model: + $ref: '#/definitions/MetricQuery' + reduce: + description: metric points'value的运算方式 + type: string + x-go-name: Reduce + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + to: + type: string + x-go-name: To + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + Condition: + properties: + operators: + items: + type: string + type: array + x-go-name: Operators + params: + items: + format: double + type: number + type: array + x-go-name: Params + type: + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + Duration: + description: |- + A Duration represents the elapsed time between two instants + as an int64 nanosecond count. The representation limits the + largest representable duration to approximately 290 years. + format: int64 + type: integer + x-go-package: time + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + EvalMatch: + properties: + condition: + type: string + x-go-name: Condition + metric: + type: string + x-go-name: Metric + tags: + additionalProperties: + type: string + type: object + x-go-name: Tags + unit: + type: string + x-go-name: Unit + value: + format: double + type: number + x-go-name: Value + value_str: + type: string + x-go-name: ValueStr + title: EvalMatch represents the series violating the threshold. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + JoinResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + MeterAlertCreateInput: + properties: + account_id: + description: 云账号 Id + type: string + x-go-name: AccountId + channel: + description: '通知方式, 比如: email, mobile' + type: string + x-go-name: Channel + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + period: + description: 查询指标周期 + type: string + x-go-name: Period + project_id: + description: 项目 Id string + type: string + x-go-name: ProjectId + provider: + description: 云平台类型 + type: string + x-go-name: Provider + recipients: + description: 通知接受者 + type: string + x-go-name: Recipients + settings: + $ref: '#/definitions/AlertSetting' + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + type: + description: '监控资源类型, 比如: balance, resFree, monthFee' + type: string + x-go-name: Type + used_by: + type: string + x-go-name: UsedBy + window: + description: 每隔多久查询一次 + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MeterAlertDetails: + properties: + account_id: + type: string + x-go-name: AccountId + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + channel: + type: string + x-go-name: Channel + comparator: + type: string + x-go-name: Comparator + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + db: + type: string + x-go-name: DB + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + field: + type: string + x-go-name: Field + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + measurement: + type: string + x-go-name: Measurement + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: ProjectId + provider: + type: string + x-go-name: Provider + recipients: + type: string + x-go-name: Recipients + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + threshold: + format: double + type: number + x-go-name: Threshold + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + window: + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MeterAlertUpdateInput: + properties: + channel: + description: '通知方式, 比如: email, mobile' + type: string + x-go-name: Channel + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + project_id: + description: 项目 Id + type: string + x-go-name: ProjectId + recipients: + description: 通知接受者 + type: string + x-go-name: Recipients + settings: + $ref: '#/definitions/AlertSetting' + status: + type: string + x-go-name: Status + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricCreateInput: + properties: + measurement: + $ref: '#/definitions/MetricMeasurementCreateInput' + metric_fields: + items: + $ref: '#/definitions/MetricFieldCreateInput' + type: array + x-go-name: MetricFields + scope: + type: string + x-go-name: Scope + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + metric_fields: + items: + $ref: '#/definitions/MetricFieldDetail' + type: array + x-go-name: MetricFields + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + scope: + type: string + x-go-name: Scope + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricFieldCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + display_name: + type: string + x-go-name: DisplayName + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + score: + format: int64 + type: integer + x-go-name: Score + unit: + type: string + x-go-name: Unit + value_type: + type: string + x-go-name: ValueType + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricFieldDetail: + properties: + display_name: + type: string + x-go-name: DisplayName + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + unit: + type: string + x-go-name: Unit + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricFieldListInput: + properties: + belong_scope: + description: 指定匹配的范围，可能值为project, domain or system + type: string + x-go-name: BelongScope + details: + description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + type: boolean + x-go-name: Details + display_name: + type: string + x-go-name: DisplayName + domain_tags: + $ref: '#/definitions/TTagSetList' + enabled: + description: 以资源是否启用/禁用过滤列表 + type: boolean + x-go-name: Enabled + export_keys: + description: 用于数据导出，指定导出的数据字段 + type: string + x-go-name: ExportKeys + field: + description: 返回结果只包含指定的字段 + items: + type: string + type: array + x-go-name: Field + filter: + description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + items: + type: string + type: array + x-go-name: Filter + filter_any: + description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + type: boolean + x-go-name: FilterAny + id: + description: 以资源ID过滤列表 + items: + type: string + type: array + x-go-name: Ids + joint_filter: + description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + items: + type: string + type: array + x-go-name: JointFilter + limit: + default: 20 + description: 查询限制量 + format: int64 + type: integer + x-go-name: Limit + name: + description: 以资源名称过滤列表 + items: + type: string + type: array + x-go-name: Names + no_domain_tags: + $ref: '#/definitions/TTagSetList' + no_obj_tags: + $ref: '#/definitions/TTagSetList' + no_project_tags: + $ref: '#/definitions/TTagSetList' + no_tags: + $ref: '#/definitions/TTagSet' + obj_tags: + $ref: '#/definitions/TTagSetList' + offset: + default: 0 + description: 查询偏移量 + format: int64 + type: integer + x-go-name: Offset + order: + description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + type: string + x-go-name: Order + order_by: + description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + items: + type: string + type: array + x-go-name: OrderBy + order_by_domain: + description: 按domain名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByDomain + order_by_project: + description: 按project名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByProject + order_by_tag: + description: 通过标签排序 + type: string + x-go-name: OrderByTag + policy_project_tags: + $ref: '#/definitions/TTagSetList' + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_domain_ids: + description: 对具有域属性的资源，严格匹配域ID + items: + type: string + type: array + x-go-name: ProjectDomainIds + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_ids: + description: 对具有项目属性的资源，严格匹配项目ID + items: + type: string + type: array + x-go-name: ProjectIds + project_tags: + $ref: '#/definitions/TTagSetList' + scope: + description: 指定查询的权限范围，可能值为project, domain or system + type: string + x-go-name: Scope + search: + description: 模糊搜索所有字段 + type: string + x-go-name: Search + show_emulated: + description: 显示所有的资源，包括模拟的资源 + type: boolean + x-go-name: ShowEmulated + show_fail_reason: + description: 返回结果携带delete_fail_reason和update_fail_reason字段 + type: boolean + x-go-name: ShowFailReason + status: + description: 以资源的状态过滤列表 + items: + type: string + type: array + x-go-name: Status + tags: + $ref: '#/definitions/TTagSet' + unit: + type: string + x-go-name: Unit + with_any_meta: + description: 返回包含任意标签的资源 + type: boolean + x-go-name: WithAnyMeta + with_cloud_meta: + description: 返回包含外部标签的资源 + type: boolean + x-go-name: WithCloudMeta + with_meta: + description: 返回列表数据中包含资源的标签数据（Metadata） + type: boolean + x-go-name: WithMeta + with_user_meta: + description: 返回包含用户标签的资源 + type: boolean + x-go-name: WithUserMeta + without_user_meta: + description: |- + deprecated + 返回资源的标签不包含用户标签 + type: boolean + x-go-name: WithoutUserMeta + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricFieldUpdateInput: + properties: + Id: + type: string + description: + description: 资源描述 + type: string + x-go-name: Description + display_name: + type: string + x-go-name: DisplayName + name: + description: 资源名称 + type: string + x-go-name: Name + score: + format: int64 + type: integer + x-go-name: Score + unit: + type: string + x-go-name: Unit + value_type: + type: string + x-go-name: ValueType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricMeasurementCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + database: + type: string + x-go-name: Database + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + display_name: + type: string + x-go-name: DisplayName + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + res_type: + type: string + x-go-name: ResType + score: + format: int64 + type: integer + x-go-name: Score + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricMeasurementListInput: + properties: + belong_scope: + description: 指定匹配的范围，可能值为project, domain or system + type: string + x-go-name: BelongScope + details: + description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + type: boolean + x-go-name: Details + display_name: + type: string + x-go-name: DisplayName + domain_tags: + $ref: '#/definitions/TTagSetList' + enabled: + description: 以资源是否启用/禁用过滤列表 + type: boolean + x-go-name: Enabled + export_keys: + description: 用于数据导出，指定导出的数据字段 + type: string + x-go-name: ExportKeys + field: + description: 返回结果只包含指定的字段 + items: + type: string + type: array + x-go-name: Field + filter: + description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + items: + type: string + type: array + x-go-name: Filter + filter_any: + description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + type: boolean + x-go-name: FilterAny + id: + description: 以资源ID过滤列表 + items: + type: string + type: array + x-go-name: Ids + joint_filter: + description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + items: + type: string + type: array + x-go-name: JointFilter + limit: + default: 20 + description: 查询限制量 + format: int64 + type: integer + x-go-name: Limit + name: + description: 以资源名称过滤列表 + items: + type: string + type: array + x-go-name: Names + no_domain_tags: + $ref: '#/definitions/TTagSetList' + no_obj_tags: + $ref: '#/definitions/TTagSetList' + no_project_tags: + $ref: '#/definitions/TTagSetList' + no_tags: + $ref: '#/definitions/TTagSet' + obj_tags: + $ref: '#/definitions/TTagSetList' + offset: + default: 0 + description: 查询偏移量 + format: int64 + type: integer + x-go-name: Offset + order: + description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + type: string + x-go-name: Order + order_by: + description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + items: + type: string + type: array + x-go-name: OrderBy + order_by_domain: + description: 按domain名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByDomain + order_by_project: + description: 按project名称排序，可能值为asc|desc + pattern: asc|desc + type: string + x-go-name: OrderByProject + order_by_tag: + description: 通过标签排序 + type: string + x-go-name: OrderByTag + policy_project_tags: + $ref: '#/definitions/TTagSetList' + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_domain_ids: + description: 对具有域属性的资源，严格匹配域ID + items: + type: string + type: array + x-go-name: ProjectDomainIds + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + project_ids: + description: 对具有项目属性的资源，严格匹配项目ID + items: + type: string + type: array + x-go-name: ProjectIds + project_tags: + $ref: '#/definitions/TTagSetList' + res_type: + type: string + x-go-name: ResType + scope: + description: 指定查询的权限范围，可能值为project, domain or system + type: string + x-go-name: Scope + search: + description: 模糊搜索所有字段 + type: string + x-go-name: Search + show_emulated: + description: 显示所有的资源，包括模拟的资源 + type: boolean + x-go-name: ShowEmulated + show_fail_reason: + description: 返回结果携带delete_fail_reason和update_fail_reason字段 + type: boolean + x-go-name: ShowFailReason + status: + description: 以资源的状态过滤列表 + items: + type: string + type: array + x-go-name: Status + tags: + $ref: '#/definitions/TTagSet' + with_any_meta: + description: 返回包含任意标签的资源 + type: boolean + x-go-name: WithAnyMeta + with_cloud_meta: + description: 返回包含外部标签的资源 + type: boolean + x-go-name: WithCloudMeta + with_meta: + description: 返回列表数据中包含资源的标签数据（Metadata） + type: boolean + x-go-name: WithMeta + with_user_meta: + description: 返回包含用户标签的资源 + type: boolean + x-go-name: WithUserMeta + without_user_meta: + description: |- + deprecated + 返回资源的标签不包含用户标签 + type: boolean + x-go-name: WithoutUserMeta + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricMeasurementUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + display_name: + type: string + x-go-name: DisplayName + name: + description: 资源名称 + type: string + x-go-name: Name + res_type: + type: string + x-go-name: ResType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricQuery: + properties: + alias: + type: string + x-go-name: Alias + database: + type: string + x-go-name: Database + group_by: + items: + $ref: '#/definitions/MetricQueryPart' + type: array + x-go-name: GroupBy + interval: + type: string + x-go-name: Interval + measurement: + type: string + x-go-name: Measurement + policy: + type: string + x-go-name: Policy + result_format: + type: string + x-go-name: ResultFormat + select: + items: + $ref: '#/definitions/MetricQuerySelect' + type: array + x-go-name: Selects + tags: + items: + $ref: '#/definitions/MetricQueryTag' + type: array + x-go-name: Tags + tz: + type: string + x-go-name: Tz + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricQueryPart: + properties: + params: + items: + type: string + type: array + x-go-name: Params + type: + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricQuerySelect: + items: + $ref: '#/definitions/MetricQueryPart' + type: array + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricQueryTag: + properties: + condition: + type: string + x-go-name: Condition + key: + type: string + x-go-name: Key + operator: + type: string + x-go-name: Operator + value: + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MetricUpdateInput: + properties: + measurement: + $ref: '#/definitions/MetricMeasurementUpdateInput' + metric_fields: + items: + $ref: '#/definitions/MetricFieldUpdateInput' + type: array + x-go-name: MetricFields + scope: + type: string + x-go-name: Scope + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertCreateInput: + properties: + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + metric_type: + $ref: '#/definitions/MigrationAlertMetricType' + migration_settings: + $ref: '#/definitions/MigrationAlertSettings' + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + period: + description: Period of querying metrics + type: string + x-go-name: Period + settings: + $ref: '#/definitions/AlertSetting' + threshold: + description: Threshold is the value to trigger migration + format: double + type: number + x-go-name: Threshold + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertMetricType: + type: string + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertSettings: + properties: + source: + $ref: '#/definitions/MigrationAlertSettingsSource' + target: + $ref: '#/definitions/MigrationAlertSettingsTarget' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertSettingsSource: + properties: + guest_ids: + items: + type: string + type: array + x-go-name: GuestIds + host_ids: + items: + type: string + type: array + x-go-name: HostIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MigrationAlertSettingsTarget: + properties: + host_ids: + items: + type: string + type: array + x-go-name: HostIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MonitorResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + alert_status: + type: string + x-go-name: AlertStatus + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + res_id: + type: string + x-go-name: ResId + res_type: + type: string + x-go-name: ResType + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MonitorResourceDetails: + properties: + access_ip: + type: string + x-go-name: AccessIp + account: + description: 云账号名称 + example: google-account + type: string + x-go-name: Account + attach_alert_count: + format: int64 + type: integer + x-go-name: AttachAlertCount + brand: + description: 云平台品牌 + example: Google + type: string + x-go-name: Brand + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + cloud_env: + description: 云环境 + example: public + type: string + x-go-name: CloudEnv + cloudregion: + description: 区域的名称 + type: string + x-go-name: Cloudregion + delete_fail_reason: + $ref: '#/definitions/Error' + environment: + description: Environment + type: string + x-go-name: Environment + hypervisor: + type: string + x-go-name: Hypervisor + ips: + type: string + x-go-name: Ips + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + provider: + description: 云平台名称 + example: Google + type: string + x-go-name: Provider + region: + description: 区域的名称 + example: Default + type: string + x-go-name: Region + region_ext_id: + description: 纳管云区域的Id + example: 59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExtId + region_external_id: + description: 纳管云区域的组合Id(平台+Id) + example: ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4 + type: string + x-go-name: RegionExternalId + region_id: + description: 区域的Id + example: default + type: string + x-go-name: RegionId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + MonitorResourceJointDetails: + properties: + alert_name: + type: string + x-go-name: AlertName + alert_rule: + type: object + x-go-name: AlertRule + is_set_shield: + type: boolean + x-go-name: IsSetShield + level: + type: string + x-go-name: Level + res_id: + type: string + x-go-name: ResId + res_name: + type: string + x-go-name: ResName + res_type: + type: string + x-go-name: ResType + send_state: + type: string + x-go-name: SendState + state: + type: string + x-go-name: State + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + NodeAlertCreateInput: + properties: + channel: + description: '通知方式, 比如: email, mobile' + type: string + x-go-name: Channel + common_alert_create_input: + $ref: '#/definitions/CommonAlertCreateInput' + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + customize_config: + description: customize info + type: object + x-go-name: CustomizeConfig + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + metric: + description: 监控指标名称 + type: string + x-go-name: Metric + name: + description: 报警名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + node_id: + description: 监控资源 Id + type: string + x-go-name: NodeId + node_name: + description: 监控资源名称 + type: string + x-go-name: NodeName + period: + description: 查询指标周期 + type: string + x-go-name: Period + recipients: + description: 通知接受者 + type: string + x-go-name: Recipients + settings: + $ref: '#/definitions/AlertSetting' + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + type: + description: '监控资源类型, 比如: guest, host' + type: string + x-go-name: Type + used_by: + type: string + x-go-name: UsedBy + window: + description: 每隔多久查询一次 + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + NodeAlertDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + channel: + type: string + x-go-name: Channel + comparator: + type: string + x-go-name: Comparator + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + db: + type: string + x-go-name: DB + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + field: + type: string + x-go-name: Field + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + measurement: + type: string + x-go-name: Measurement + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + metric: + type: string + x-go-name: Metric + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + node_id: + type: string + x-go-name: NodeId + node_name: + type: string + x-go-name: NodeName + notifier_id: + type: string + x-go-name: NotifierId + period: + type: string + x-go-name: Period + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + recipients: + type: string + x-go-name: Recipients + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + threshold: + format: double + type: number + x-go-name: Threshold + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + window: + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + NodeAlertUpdateInput: + properties: + channel: + description: '通知方式, 比如: email, mobile' + type: string + x-go-name: Channel + comparator: + description: '比较运算符, 比如: >, <, >=, <=' + type: string + x-go-name: Comparator + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metric: + description: 监控指标名称 + type: string + x-go-name: Metric + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + node_id: + description: 监控资源 Id + type: string + x-go-name: NodeId + node_name: + description: 监控资源名称 + type: string + x-go-name: NodeName + period: + description: 查询指标周期 + type: string + x-go-name: Period + recipients: + description: 通知接受者 + type: string + x-go-name: Recipients + settings: + $ref: '#/definitions/AlertSetting' + threshold: + description: 报警阀值 + format: double + type: number + x-go-name: Threshold + type: + description: '监控资源类型, 比如: guest, host' + type: string + x-go-name: Type + window: + description: 每隔多久查询一次 + type: string + x-go-name: Window + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + NotificationCreateInput: + properties: + disable_resolve_message: + description: 是否禁用报警恢复提醒 + type: boolean + x-go-name: DisableResolveMessage + frequency: + $ref: '#/definitions/Duration' + is_default: + description: 是否为默认通知配置 + type: boolean + x-go-name: IsDefault + name: + description: 报警通知名称 + type: string + x-go-name: Name + send_reminder: + description: 是否一直提醒 + type: boolean + x-go-name: SendReminder + settings: + description: 通知配置 + type: object + x-go-name: Settings + type: + description: 类型 + type: string + x-go-name: Type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + PanelDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + common_alert_metric_details: + items: + $ref: '#/definitions/CommonAlertMetricDetails' + type: array + x-go-name: CommonAlertMetricDetails + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + customize_config: + type: object + x-go-name: CustomizeConfig + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + eval_data: + type: object + x-go-name: EvalData + execution_error: + description: Silenced bool + type: string + x-go-name: ExecutionError + execution_error_state: + type: string + x-go-name: ExecutionErrorState + for: + description: |- + If an alert rule has a configured `For` and the query violates the configured threshold + it will first go from `OK` to `Pending`. Going from `OK` to `Pending` will not send any + notifications. Once the alert rule has been firing for more than `For` duration, it will + change to `Alerting` and send alert notifications. + format: int64 + type: integer + x-go-name: For + frequency: + description: Frequency is evaluate period + format: int64 + type: integer + x-go-name: Frequency + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + last_state_change: + format: date-time + type: string + x-go-name: LastStateChange + level: + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + type: string + x-go-name: NoDataState + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + res_type: + type: string + x-go-name: ResType + scope: + type: string + x-go-name: Scope + settings: + type: object + x-go-name: Settings + state: + type: string + x-go-name: State + state_changes: + format: int64 + type: integer + x-go-name: StateChanges + status: + description: 资源状态 + type: string + x-go-name: Status + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + tenant_id: + description: 项目Id + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + used_by: + type: string + x-go-name: UsedBy + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + PerformChangeProjectOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformFreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformUnfreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProjectStatistic: + properties: + Count: + format: int64 + type: integer + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResultLogEntry: + properties: + data: + type: object + x-go-name: Data + message: + type: string + x-go-name: Message + title: ResultLogEntry represents log data for the alert evaluation. + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + SharedDomain: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TTagSet: + items: + $ref: '#/definitions/STag' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + V1AlertUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + enabled: + description: 启用报警 + type: boolean + x-go-name: Enabled + execution_error_state: + description: 报警执行错误将当前报警状态设置为对应的状态 + type: string + x-go-name: ExecutionErrorState + for: + description: 报警持续时间 + format: int64 + type: integer + x-go-name: For + frequency: + description: 报警执行频率 + format: int64 + type: integer + x-go-name: Frequency + level: + description: 报警级别 + type: string + x-go-name: Level + message: + type: string + x-go-name: Message + name: + description: 资源名称 + type: string + x-go-name: Name + no_data_state: + description: 没有收到监控指标时将当前报警状态设置为对应的状态 + type: string + x-go-name: NoDataState + settings: + $ref: '#/definitions/AlertSetting' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/monitor + VirtualJointResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + VirtualResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis +host: '"127.0.0.1:8889"' +info: + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Monitor API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" +paths: + /alert_dash_boards: + get: + description: 列表 + operationId: alert_dash_board_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/alert_dash_board_ListItemFilterOutput' + summary: 列表 + tags: + - alert_dash_board + post: + description: 新建 + operationId: alert_dash_board_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_dash_board + /alert_dash_boards/{id}: + delete: + description: 删除 + operationId: alert_dash_board_CustomizeDelete + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_dash_board + get: + description: 获取详情 + operationId: alert_dash_board_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_dash_board + put: + description: 更新 + operationId: alert_dash_board_ValidateUpdateData + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_dash_board + /alert_dash_boards/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_dash_board_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_dash_board + post: + description: 执行操作ClassMetadata + operationId: alert_dash_board_PerformClassMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_dash_board + /alert_dash_boards/{id}/clone-dashboard: + post: + description: 执行操作CloneDashboard + operationId: alert_dash_board_PerformCloneDashboard + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertCloneDashboardInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformCloneDashboardOutput' + summary: 执行操作CloneDashboard + tags: + - alert_dash_board + /alert_dash_boards/{id}/clone-panel: + post: + description: 执行操作ClonePanel + operationId: alert_dash_board_PerformClonePanel + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertClonePanelInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformClonePanelOutput' + summary: 执行操作ClonePanel + tags: + - alert_dash_board + /alert_dash_boards/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_dash_board_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_dash_board + /alert_dash_boards/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_dash_board_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_dash_board + /alert_dash_boards/{id}/set-scope: + post: + description: 执行操作SetScope + operationId: alert_dash_board_PerformSetScope + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformSetScopeOutput' + summary: 执行操作SetScope + tags: + - alert_dash_board + /alert_dash_boards/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_dash_board_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_dash_board + /alert_dash_boards/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_dash_board_GetDetailsStatus + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dash_board_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_dash_board + post: + description: 执行操作Status + operationId: alert_dash_board_PerformStatus + parameters: + - description: The Id or Name of alert_dash_board + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_dash_board + /alert_dash_boards/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_dash_board_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_dash_board + /alert_dash_boards/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_dash_board_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_dash_board: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dash_board_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_dash_board + /alert_dash_boards/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_dash_board_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_dash_board + /alert_dash_boards/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_dash_board_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_dash_board + /alert_dash_boards/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_dash_board_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_dash_board + /alert_dash_boards/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_dash_board_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_dash_board + /alert_dash_boards/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_dash_board_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_dash_board_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_dash_board + /alert_dashboard_panels: + get: + description: 列表 + operationId: alert_dashboard_panel_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_ListItemFilterOutput' + summary: 列表 + tags: + - alert_dashboard_panel + post: + description: 新建 + operationId: alert_dashboard_panel_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JoinResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_dashboard_panel + /alert_dashboard_panels/{id}: + delete: + description: 删除 + operationId: alert_dashboard_panel_CustomizeDelete + parameters: + - description: The Id or Name of alert_dashboard_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_dashboard_panel + get: + description: 获取详情 + operationId: alert_dashboard_panel_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_dashboard_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_dashboard_panel + put: + description: 更新 + operationId: alert_dashboard_panel_ValidateUpdateData + parameters: + - description: The Id or Name of alert_dashboard_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_dashboard_panel + /alert_dashboard_panels/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_dashboard_panel_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_dashboard_panel + /alert_dashboard_panels/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_dashboard_panel_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_dashboard_panel + /alert_dashboard_panels/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_dashboard_panel_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_dashboard_panel + /alert_dashboard_panels/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_dashboard_panel_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_dashboard_panel_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_dashboard_panel + /alert_notifications: + get: + description: 列表 + operationId: alert_notification_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 类型 + in: query + name: type + type: string + x-go-name: Type + responses: + "200": + $ref: '#/responses/alert_notification_ListItemFilterOutput' + summary: 列表 + tags: + - alert_notification + post: + description: 新建 + operationId: alert_notification_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/NotificationCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_notification + /alert_notifications/{id}: + delete: + description: 删除 + operationId: alert_notification_CustomizeDelete + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_notification + get: + description: 获取详情 + operationId: alert_notification_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_notification + put: + description: 更新 + operationId: alert_notification_ValidateUpdateData + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_notification + /alert_notifications/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: alert_notification_PerformCancelDelete + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - alert_notification + /alert_notifications/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: alert_notification_PerformChangeOwner + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - alert_notification + /alert_notifications/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: alert_notification_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - alert_notification + /alert_notifications/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_notification_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_notification + post: + description: 执行操作ClassMetadata + operationId: alert_notification_PerformClassMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_notification + /alert_notifications/{id}/freeze: + post: + description: 执行操作Freeze + operationId: alert_notification_PerformFreeze + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - alert_notification + /alert_notifications/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_notification_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_notification + /alert_notifications/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_notification_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_notification + /alert_notifications/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_notification_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_notification + /alert_notifications/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_notification_GetDetailsStatus + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_notification_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_notification + post: + description: 执行操作Status + operationId: alert_notification_PerformStatus + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_notification + /alert_notifications/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: alert_notification_PerformUnfreeze + parameters: + - description: The Id or Name of alert_notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - alert_notification + /alert_notifications/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_notification_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_notification + /alert_notifications/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: alert_notification_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - alert_notification + /alert_notifications/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: alert_notification_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - alert_notification + /alert_notifications/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: alert_notification_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - alert_notification + /alert_notifications/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: alert_notification_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - alert_notification + /alert_notifications/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_notification_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_notification: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_notification_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_notification + /alert_notifications/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_notification_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_notification + /alert_notifications/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_notification_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_notification + /alert_notifications/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_notification_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_notification + /alert_notifications/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_notification_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_notification + /alert_notifications/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_notification_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_notification_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_notification + /alert_panels: + get: + description: 列表 + operationId: alert_panel_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - in: query + name: dashboard_id + type: string + x-go-name: DashboardId + responses: + "200": + $ref: '#/responses/alert_panel_ListItemFilterOutput' + summary: 列表 + tags: + - alert_panel + post: + description: 新建 + operationId: alert_panel_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_panel: + $ref: '#/definitions/AlertPanelCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_panel + /alert_panels/{id}: + delete: + description: 删除 + operationId: alert_panel_CustomizeDelete + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_panel + get: + description: 获取详情 + operationId: alert_panel_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_panel + put: + description: 更新 + operationId: alert_panel_ValidateUpdateData + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_panel + /alert_panels/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_panel_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_panel + post: + description: 执行操作ClassMetadata + operationId: alert_panel_PerformClassMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_panel + /alert_panels/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_panel_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_panel + /alert_panels/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_panel_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_panel + /alert_panels/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_panel_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_panel + /alert_panels/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_panel_GetDetailsStatus + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_panel_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_panel + post: + description: 执行操作Status + operationId: alert_panel_PerformStatus + parameters: + - description: The Id or Name of alert_panel + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_panel: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_panel + /alert_panels/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_panel_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_panel + /alert_panels/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_panel_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_panel: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_panel_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_panel + /alert_panels/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_panel_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_panel + /alert_panels/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_panel_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_panel + /alert_panels/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_panel_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_panel + /alert_panels/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_panel_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_panel + /alert_panels/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_panel_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_panel_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_panel + /alert_record_shields: + get: + description: 列表 + operationId: alert_record_shield_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - in: query + name: alert_name + type: string + x-go-name: AlertName + - in: query + name: res_type + type: string + x-go-name: ResType + - in: query + name: res_name + type: string + x-go-name: ResName + - in: query + name: res_id + type: string + x-go-name: ResId + - in: query + name: alert_id + type: string + x-go-name: AlertId + - format: date-time + in: query + name: start_time + type: string + x-go-name: StartTime + - format: date-time + in: query + name: end_time + type: string + x-go-name: EndTime + responses: + "200": + $ref: '#/responses/alert_record_shield_ListItemFilterOutput' + summary: 列表 + tags: + - alert_record_shield + post: + description: 新建 + operationId: alert_record_shield_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_record_shield + /alert_record_shields/{id}: + delete: + description: 删除 + operationId: alert_record_shield_CustomizeDelete + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_record_shield + get: + description: 获取详情 + operationId: alert_record_shield_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_record_shield + put: + description: 更新 + operationId: alert_record_shield_ValidateUpdateData + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_record_shield + /alert_record_shields/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_record_shield_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_record_shield + post: + description: 执行操作ClassMetadata + operationId: alert_record_shield_PerformClassMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_record_shield + /alert_record_shields/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_record_shield_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_record_shield + /alert_record_shields/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_record_shield_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_record_shield + /alert_record_shields/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_record_shield_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_record_shield + /alert_record_shields/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_record_shield_GetDetailsStatus + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_shield_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_record_shield + post: + description: 执行操作Status + operationId: alert_record_shield_PerformStatus + parameters: + - description: The Id or Name of alert_record_shield + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record_shield: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_record_shield + /alert_record_shields/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_record_shield_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_record_shield + /alert_record_shields/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_record_shield_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_record_shield: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_shield_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_record_shield + /alert_record_shields/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_record_shield_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_record_shield + /alert_record_shields/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_record_shield_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_record_shield + /alert_record_shields/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_record_shield_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_record_shield + /alert_record_shields/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_record_shield_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_record_shield + /alert_record_shields/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_record_shield_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_record_shield_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_record_shield + /alert_records: + get: + description: 列表 + operationId: alert_record_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - in: query + name: alert_id + type: string + x-go-name: AlertId + - in: query + name: level + type: string + x-go-name: Level + - in: query + name: state + type: string + x-go-name: State + - in: query + name: res_type + type: string + x-go-name: ResType + - in: query + name: alerting + type: boolean + x-go-name: Alerting + - in: query + name: res_name + type: string + x-go-name: ResName + responses: + "200": + $ref: '#/responses/alert_record_ListItemFilterOutput' + summary: 列表 + tags: + - alert_record + post: + description: 新建 + operationId: alert_record_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_record + /alert_records/{id}: + delete: + description: 删除 + operationId: alert_record_CustomizeDelete + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_record + get: + description: 获取详情 + operationId: alert_record_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_record + put: + description: 更新 + operationId: alert_record_ValidateUpdateData + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_record + /alert_records/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_record_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_record + post: + description: 执行操作ClassMetadata + operationId: alert_record_PerformClassMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_record + /alert_records/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_record_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_record + /alert_records/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_record_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_record + /alert_records/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_record_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_record + /alert_records/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_record_GetDetailsStatus + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_record_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert_record + post: + description: 执行操作Status + operationId: alert_record_PerformStatus + parameters: + - description: The Id or Name of alert_record + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_record: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert_record + /alert_records/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_record_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_record + /alert_records/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_record_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_record: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_record_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_record + /alert_records/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_record_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_record_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_record + /alert_records/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_record_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_record_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_record + /alert_records/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_record_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert_record + /alert_records/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_record_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_record + /alert_records/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_record_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_record + /alert_records/total-alert: + get: + description: 获取指定资源类的信息TotalAlert + operationId: alert_record_GetPropertyTotalAlert + responses: + "200": + $ref: '#/responses/alert_record_GetPropertyTotalAlertOutput' + summary: 获取指定资源类的信息TotalAlert + tags: + - alert_record + /alert_resource_alerts: + get: + description: 列表 + operationId: alert_resource_alert_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - in: query + name: alert_resource_id + type: string + x-go-name: AlertResourceId + - in: query + name: alert_id + type: string + x-go-name: AlertId + responses: + "200": + $ref: '#/responses/alert_resource_alert_ListItemFilterOutput' + summary: 列表 + tags: + - alert_resource_alert + post: + description: 新建 + operationId: alert_resource_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_resource_alert: + $ref: '#/definitions/JoinResourceBaseCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_resource_alert + /alert_resource_alerts/{id}: + delete: + description: 删除 + operationId: alert_resource_alert_CustomizeDelete + parameters: + - description: The Id or Name of alert_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_resource_alert + get: + description: 获取详情 + operationId: alert_resource_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_resource_alert + put: + description: 更新 + operationId: alert_resource_alert_ValidateUpdateData + parameters: + - description: The Id or Name of alert_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource_alert: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_resource_alert + /alert_resource_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_resource_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_resource_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_resource_alert + /alert_resource_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_resource_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_resource_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_resource_alert + /alert_resource_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_resource_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_resource_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_resource_alert + /alert_resource_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_resource_alert_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_resource_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_resource_alert + /alert_resources: + get: + description: 列表 + operationId: alert_resource_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - in: query + name: type + type: string + x-go-name: Type + responses: + "200": + $ref: '#/responses/alert_resource_ListItemFilterOutput' + summary: 列表 + tags: + - alert_resource + post: + description: 新建 + operationId: alert_resource_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert_resource: + $ref: '#/definitions/StandaloneResourceCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert_resource + /alert_resources/{id}: + delete: + description: 删除 + operationId: alert_resource_CustomizeDelete + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert_resource + get: + description: 获取详情 + operationId: alert_resource_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert_resource + put: + description: 更新 + operationId: alert_resource_ValidateUpdateData + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert_resource + /alert_resources/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_resource_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert_resource + post: + description: 执行操作ClassMetadata + operationId: alert_resource_PerformClassMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert_resource + /alert_resources/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_resource_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_resource_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert_resource + /alert_resources/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_resource_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert_resource + /alert_resources/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_resource_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert_resource + /alert_resources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_resource_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert_resource + /alert_resources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_resource_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert_resource: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_resource_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert_resource + /alert_resources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_resource_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert_resource + /alert_resources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_resource_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert_resource + /alert_resources/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_resource_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert_resource + /alert_resources/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_resource_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_resource_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert_resource + /alerts: + get: + description: 列表 + operationId: alert_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/alert_ListItemFilterOutput' + summary: 列表 + tags: + - alert + post: + description: 新建 + operationId: alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/AlertCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - alert + /alerts/{id}: + delete: + description: 删除 + operationId: alert_CustomizeDelete + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - alert + get: + description: 获取详情 + operationId: alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - alert + put: + description: 更新 + operationId: alert_ValidateUpdateData + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/AlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - alert + /alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - alert + post: + description: 执行操作ClassMetadata + operationId: alert_PerformClassMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - alert + /alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: alert_PerformDisable + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - alert + /alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: alert_PerformEnable + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - alert + /alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: alert_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - alert + /alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: alert_PerformPause + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - alert + /alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - alert + /alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - alert + /alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: alert_GetDetailsStatus + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - alert + post: + description: 执行操作Status + operationId: alert_PerformStatus + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - alert + /alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: alert_PerformTestRun + parameters: + - description: The Id or Name of alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - alert + /alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - alert + /alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - alert + /alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - alert + /alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: alert_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - alert + /alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - alert + /alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - alert + /alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - alert + /common_alerts: + get: + description: 列表 + operationId: common_alert_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: |- + V1AlertListInput + 报警类型 + in: query + name: alert_type + type: string + x-go-name: AlertType + - description: 监控指标名称 + in: query + name: metric + type: string + x-go-name: Metric + - in: query + name: level + type: string + x-go-name: Level + - in: query + items: + type: string + name: res_type + type: array + x-go-name: ResType + - in: query + name: used_by + type: string + x-go-name: UsedBy + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: string + x-go-name: Name + responses: + "200": + $ref: '#/responses/common_alert_ListItemFilterOutput' + summary: 列表 + tags: + - common_alert + post: + description: 新建 + operationId: common_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - common_alert + /common_alerts/{id}: + delete: + description: 删除 + operationId: common_alert_CustomizeDelete + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - common_alert + get: + description: 获取详情 + operationId: common_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - common_alert + put: + description: 更新 + operationId: common_alert_ValidateUpdateData + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - common_alert + /common_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: common_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - common_alert + post: + description: 执行操作ClassMetadata + operationId: common_alert_PerformClassMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - common_alert + /common_alerts/{id}/config: + post: + description: 执行操作Config + operationId: common_alert_PerformConfig + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_PerformConfigOutput' + summary: 执行操作Config + tags: + - common_alert + /common_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: common_alert_PerformDisable + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - common_alert + /common_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: common_alert_PerformEnable + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - common_alert + /common_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: common_alert_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - common_alert + /common_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: common_alert_PerformPause + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - common_alert + /common_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: common_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - common_alert + /common_alerts/{id}/set-scope: + post: + description: 执行操作SetScope + operationId: common_alert_PerformSetScope + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_PerformSetScopeOutput' + summary: 执行操作SetScope + tags: + - common_alert + /common_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: common_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - common_alert + /common_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: common_alert_GetDetailsStatus + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/common_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - common_alert + post: + description: 执行操作Status + operationId: common_alert_PerformStatus + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - common_alert + /common_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: common_alert_PerformTestRun + parameters: + - description: The Id or Name of common_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - common_alert + /common_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: common_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/common_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - common_alert + /common_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: common_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + common_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/common_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - common_alert + /common_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: common_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/common_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - common_alert + /common_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: common_alert_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/common_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - common_alert + /common_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: common_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/common_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - common_alert + /common_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: common_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/common_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - common_alert + /common_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: common_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/common_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - common_alert + /data_sources: + get: + description: 列表 + operationId: data_source_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + responses: + "200": + $ref: '#/responses/data_source_ListItemFilterOutput' + summary: 列表 + tags: + - data_source + post: + description: 新建 + operationId: data_source_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + data_source: + $ref: '#/definitions/StandaloneResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_ValidateCreateDataOutput' + summary: 新建 + tags: + - data_source + /data_sources/{id}: + delete: + description: 删除 + operationId: data_source_CustomizeDelete + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_CustomizeDeleteOutput' + summary: 删除 + tags: + - data_source + get: + description: 获取详情 + operationId: data_source_FetchCustomizeColumns + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - data_source + put: + description: 更新 + operationId: data_source_ValidateUpdateData + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_ValidateUpdateDataOutput' + summary: 更新 + tags: + - data_source + /data_sources/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: data_source_GetDetailsClassMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - data_source + post: + description: 执行操作ClassMetadata + operationId: data_source_PerformClassMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - data_source + /data_sources/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: data_source_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/data_source_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - data_source + /data_sources/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: data_source_PerformSetClassMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - data_source + /data_sources/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: data_source_PerformSetUserMetadata + parameters: + - description: The Id or Name of data_source + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - data_source + /data_sources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: data_source_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/data_source_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - data_source + /data_sources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: data_source_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + data_source: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/data_source_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - data_source + /data_sources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: data_source_GetPropertySplitable + responses: + "200": + $ref: '#/responses/data_source_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - data_source + /data_sources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: data_source_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/data_source_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - data_source + /data_sources/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: data_source_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/data_source_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - data_source + /data_sources/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: data_source_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/data_source_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - data_source + /meter_alerts: + get: + description: 列表 + operationId: meter_alert_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: '监控资源类型, 比如: balance, resFree, monthFee' + in: query + name: type + type: string + x-go-name: Type + - description: 云平台类型 + in: query + name: provider + type: string + x-go-name: Provider + - description: 云账号 Id + in: query + name: account_id + type: string + x-go-name: AccountId + - description: 项目 Id + in: query + name: project_id + type: string + x-go-name: ProjectId + responses: + "200": + $ref: '#/responses/meter_alert_ListItemFilterOutput' + summary: 列表 + tags: + - meter_alert + post: + description: 新建 + operationId: meter_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + meter_alert: + $ref: '#/definitions/MeterAlertCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - meter_alert + /meter_alerts/{id}: + delete: + description: 删除 + operationId: meter_alert_CustomizeDelete + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - meter_alert + get: + description: 获取详情 + operationId: meter_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - meter_alert + put: + description: 更新 + operationId: meter_alert_ValidateUpdateData + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - meter_alert + /meter_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: meter_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - meter_alert + post: + description: 执行操作ClassMetadata + operationId: meter_alert_PerformClassMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - meter_alert + /meter_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: meter_alert_PerformDisable + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - meter_alert + /meter_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: meter_alert_PerformEnable + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - meter_alert + /meter_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: meter_alert_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - meter_alert + /meter_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: meter_alert_PerformPause + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - meter_alert + /meter_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: meter_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - meter_alert + /meter_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: meter_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - meter_alert + /meter_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: meter_alert_GetDetailsStatus + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/meter_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - meter_alert + post: + description: 执行操作Status + operationId: meter_alert_PerformStatus + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - meter_alert + /meter_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: meter_alert_PerformTestRun + parameters: + - description: The Id or Name of meter_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - meter_alert + /meter_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: meter_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - meter_alert + /meter_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: meter_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + meter_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/meter_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - meter_alert + /meter_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: meter_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - meter_alert + /meter_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: meter_alert_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - meter_alert + /meter_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: meter_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - meter_alert + /meter_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: meter_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - meter_alert + /meter_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: meter_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/meter_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - meter_alert + /metric_fields: + get: + description: 列表 + operationId: metric_field_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - in: query + name: display_name + type: string + x-go-name: DisplayName + - in: query + name: unit + type: string + x-go-name: Unit + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/metric_field_ListItemFilterOutput' + summary: 列表 + tags: + - metric_field + post: + description: 新建 + operationId: metric_field_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + metric_field: + $ref: '#/definitions/MetricFieldCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_ValidateCreateDataOutput' + summary: 新建 + tags: + - metric_field + /metric_fields/{id}: + delete: + description: 删除 + operationId: metric_field_CustomizeDelete + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_CustomizeDeleteOutput' + summary: 删除 + tags: + - metric_field + get: + description: 获取详情 + operationId: metric_field_FetchCustomizeColumns + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - metric_field + put: + description: 更新 + operationId: metric_field_ValidateUpdateData + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_ValidateUpdateDataOutput' + summary: 更新 + tags: + - metric_field + /metric_fields/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: metric_field_GetDetailsClassMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - metric_field + post: + description: 执行操作ClassMetadata + operationId: metric_field_PerformClassMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - metric_field + /metric_fields/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: metric_field_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - metric_field + /metric_fields/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: metric_field_PerformSetClassMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - metric_field + /metric_fields/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: metric_field_PerformSetUserMetadata + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - metric_field + /metric_fields/{id}/status: + get: + description: 获取指定信息Status + operationId: metric_field_GetDetailsStatus + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_field_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - metric_field + post: + description: 执行操作Status + operationId: metric_field_PerformStatus + parameters: + - description: The Id or Name of metric_field + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_field: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformStatusOutput' + summary: 更新资源状态 + tags: + - metric_field + /metric_fields/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: metric_field_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/metric_field_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - metric_field + /metric_fields/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: metric_field_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + metric_field: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_field_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - metric_field + /metric_fields/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: metric_field_GetPropertySplitable + responses: + "200": + $ref: '#/responses/metric_field_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - metric_field + /metric_fields/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: metric_field_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/metric_field_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - metric_field + /metric_fields/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: metric_field_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/metric_field_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - metric_field + /metric_fields/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: metric_field_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/metric_field_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - metric_field + /metric_fields/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: metric_field_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/metric_field_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - metric_field + /metric_measurements: + get: + description: 列表 + operationId: metric_measurement_ListItemFilter + parameters: + - $ref: '#/definitions/MetricMeasurementListInput' + in: query + name: measurement + x-go-name: Measurement + - $ref: '#/definitions/MetricFieldListInput' + in: query + name: metric_fields + x-go-name: MetricFields + - in: query + name: scope + type: string + x-go-name: Scope + responses: + "200": + $ref: '#/responses/metric_measurement_ListItemFilterOutput' + summary: 列表 + tags: + - metric_measurement + post: + description: 新建 + operationId: metric_measurement_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + metric_measurement: + $ref: '#/definitions/MetricCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_ValidateCreateDataOutput' + summary: 新建 + tags: + - metric_measurement + /metric_measurements/{id}: + delete: + description: 删除 + operationId: metric_measurement_CustomizeDelete + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_CustomizeDeleteOutput' + summary: 删除 + tags: + - metric_measurement + get: + description: 获取详情 + operationId: metric_measurement_FetchCustomizeColumns + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - metric_measurement + put: + description: 更新 + operationId: metric_measurement_ValidateUpdateData + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_ValidateUpdateDataOutput' + summary: 更新 + tags: + - metric_measurement + /metric_measurements/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: metric_measurement_GetDetailsClassMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - metric_measurement + post: + description: 执行操作ClassMetadata + operationId: metric_measurement_PerformClassMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - metric_measurement + /metric_measurements/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: metric_measurement_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - metric_measurement + /metric_measurements/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: metric_measurement_PerformSetClassMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - metric_measurement + /metric_measurements/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: metric_measurement_PerformSetUserMetadata + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - metric_measurement + /metric_measurements/{id}/status: + get: + description: 获取指定信息Status + operationId: metric_measurement_GetDetailsStatus + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_measurement_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - metric_measurement + post: + description: 执行操作Status + operationId: metric_measurement_PerformStatus + parameters: + - description: The Id or Name of metric_measurement + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric_measurement: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformStatusOutput' + summary: 更新资源状态 + tags: + - metric_measurement + /metric_measurements/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: metric_measurement_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - metric_measurement + /metric_measurements/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: metric_measurement_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + metric_measurement: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_measurement_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - metric_measurement + /metric_measurements/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: metric_measurement_GetPropertySplitable + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - metric_measurement + /metric_measurements/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: metric_measurement_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - metric_measurement + /metric_measurements/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: metric_measurement_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - metric_measurement + /metric_measurements/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: metric_measurement_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - metric_measurement + /metric_measurements/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: metric_measurement_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/metric_measurement_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - metric_measurement + /metrics: + get: + description: 列表 + operationId: metric_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/metric_ListItemFilterOutput' + summary: 列表 + tags: + - metric + post: + description: 新建 + operationId: metric_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + metric: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_ValidateCreateDataOutput' + summary: 新建 + tags: + - metric + /metrics/{id}: + delete: + description: 删除 + operationId: metric_CustomizeDelete + parameters: + - description: The Id or Name of metric + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_CustomizeDeleteOutput' + summary: 删除 + tags: + - metric + get: + description: 获取详情 + operationId: metric_FetchCustomizeColumns + parameters: + - description: The Id or Name of metric + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/metric_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - metric + put: + description: 更新 + operationId: metric_ValidateUpdateData + parameters: + - description: The Id or Name of metric + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + metric: + $ref: '#/definitions/VirtualJointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_ValidateUpdateDataOutput' + summary: 更新 + tags: + - metric + /metrics/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: metric_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/metric_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - metric + /metrics/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: metric_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + metric: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/metric_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - metric + /metrics/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: metric_GetPropertySplitable + responses: + "200": + $ref: '#/responses/metric_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - metric + /metrics/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: metric_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/metric_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - metric + /migration_alerts: + get: + description: 列表 + operationId: migration_alert_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - in: query + name: metric_type + type: string + x-go-name: MetricType + responses: + "200": + $ref: '#/responses/migration_alert_ListItemFilterOutput' + summary: 列表 + tags: + - migration_alert + post: + description: 新建 + operationId: migration_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + migration_alert: + $ref: '#/definitions/MigrationAlertCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - migration_alert + /migration_alerts/{id}: + delete: + description: 删除 + operationId: migration_alert_CustomizeDelete + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - migration_alert + get: + description: 获取详情 + operationId: migration_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - migration_alert + put: + description: 更新 + operationId: migration_alert_ValidateUpdateData + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - migration_alert + /migration_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: migration_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - migration_alert + post: + description: 执行操作ClassMetadata + operationId: migration_alert_PerformClassMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - migration_alert + /migration_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: migration_alert_PerformDisable + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - migration_alert + /migration_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: migration_alert_PerformEnable + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - migration_alert + /migration_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: migration_alert_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - migration_alert + /migration_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: migration_alert_PerformPause + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - migration_alert + /migration_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: migration_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - migration_alert + /migration_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: migration_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - migration_alert + /migration_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: migration_alert_GetDetailsStatus + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/migration_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - migration_alert + post: + description: 执行操作Status + operationId: migration_alert_PerformStatus + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - migration_alert + /migration_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: migration_alert_PerformTestRun + parameters: + - description: The Id or Name of migration_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - migration_alert + /migration_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: migration_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - migration_alert + /migration_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: migration_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + migration_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/migration_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - migration_alert + /migration_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: migration_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - migration_alert + /migration_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: migration_alert_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - migration_alert + /migration_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: migration_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - migration_alert + /migration_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: migration_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - migration_alert + /migration_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: migration_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/migration_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - migration_alert + /monitor_resource_alerts: + get: + description: 列表 + operationId: monitor_resource_alert_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - in: query + name: monitor_resource_id + type: string + x-go-name: MonitorResourceId + - in: query + name: alert_id + type: string + x-go-name: AlertId + - in: query + items: + format: int64 + type: integer + name: joint_id + type: array + x-go-name: JointId + - in: query + name: alertinng + type: boolean + x-go-name: Alerting + - in: query + name: send_state + type: string + x-go-name: SendState + - in: query + name: res_type + type: string + x-go-name: ResType + - in: query + name: res_name + type: string + x-go-name: ResName + - in: query + name: alert_name + type: string + x-go-name: AlertName + - in: query + name: level + type: string + x-go-name: Level + responses: + "200": + $ref: '#/responses/monitor_resource_alert_ListItemFilterOutput' + summary: 列表 + tags: + - monitor_resource_alert + post: + description: 新建 + operationId: monitor_resource_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + monitor_resource_alert: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - monitor_resource_alert + /monitor_resource_alerts/{id}: + delete: + description: 删除 + operationId: monitor_resource_alert_CustomizeDelete + parameters: + - description: The Id or Name of monitor_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - monitor_resource_alert + get: + description: 获取详情 + operationId: monitor_resource_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of monitor_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - monitor_resource_alert + put: + description: 更新 + operationId: monitor_resource_alert_ValidateUpdateData + parameters: + - description: The Id or Name of monitor_resource_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - monitor_resource_alert + /monitor_resource_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: monitor_resource_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/monitor_resource_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - monitor_resource_alert + /monitor_resource_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: monitor_resource_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - monitor_resource_alert + /monitor_resource_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: monitor_resource_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/monitor_resource_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - monitor_resource_alert + /monitor_resource_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: monitor_resource_alert_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/monitor_resource_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - monitor_resource_alert + /monitor_resources: + get: + description: 列表 + operationId: monitor_resource_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: |- + 列出指定云平台的资源，支持的云平台如下 + + Provider | 开始支持版本 | 平台 | + -----------|------------|-------------------------------------| + OneCloud | 0.0 | OneCloud内置私有云，包括KVM和裸金属管理 | + VMware | 1.2 | VMware vCenter | + OpenStack | 2.6 | OpenStack M版本以上私有云 | + ZStack | 2.10 | ZStack私有云 | + Aliyun | 2.0 | 阿里云 | + Aws | 2.3 | Amazon AWS | + Azure | 2.2 | Microsoft Azure | + Google | 2.13 | Google Cloud Platform | + Qcloud | 2.3 | 腾讯云 | + Huawei | 2.5 | 华为公有云 | + Ucloud | 2.7 | UCLOUD | + Ctyun | 2.13 | 天翼云 | + S3 | 2.11 | 通用s3对象存储 | + Ceph | 2.11 | Ceph对象存储 | + Xsky | 2.11 | XSKY启明星辰Ceph对象存储 | + enum: + - OneCloud + - VMware + - Aliyun + - Qcloud + - Azure + - Aws + - Huawei + - OpenStack + - Ucloud + - ZStack + - Google + - Ctyun + - S3 + - Ceph + - Xsky" + in: query + items: + type: string + name: providers + type: array + x-go-name: Providers + - description: |- + 列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band + + Brand | Provider | 说明 | + ----------|----------|------------| + DStack | ZStack | 滴滴云私有云 | + in: query + items: + type: string + name: brands + type: array + x-go-name: Brands + - description: |- + 列出指定云环境的资源，支持云环境如下： + + CloudEnv | 说明 | + -----------|--------| + public | 公有云 | + private | 私有云 | + onpremise | 本地IDC | + enum: + - public + - private + - onpremise + in: query + name: cloud_env + type: string + x-go-name: CloudEnv + - description: 以平台名称排序 + in: query + name: order_by_provider + pattern: asc|desc + type: string + x-go-name: OrderByProvider + - description: 以平台品牌排序 + in: query + name: order_by_brand + pattern: asc|desc + type: string + x-go-name: OrderByBrand + - description: 列出关联指定云订阅(ID或Name)的资源 + in: query + name: cloudprovider_id + type: string + x-go-name: CloudproviderId + - description: 列出关联指定云账号(ID或Name)的资源 + in: query + items: + type: string + name: cloudaccount_id + type: array + x-go-name: CloudaccountId + - default: false + description: 过滤资源，是否为非OneCloud内置私有云管理的资源 + in: query + name: is_managed + type: boolean + x-go-name: IsManaged + - description: 以云账号名称排序 + in: query + name: order_by_account + pattern: asc|desc + type: string + x-go-name: OrderByAccount + - description: 以云订阅名称排序 + in: query + name: order_by_manager + pattern: asc|desc + type: string + x-go-name: OrderByManager + - in: query + items: + type: string + name: res_id + type: array + x-go-name: ResId + - in: query + name: res_type + type: string + x-go-name: ResType + - in: query + name: only_res_id + type: boolean + x-go-name: OnlyResId + - in: query + name: res_name + type: string + x-go-name: ResName + responses: + "200": + $ref: '#/responses/monitor_resource_ListItemFilterOutput' + summary: 列表 + tags: + - monitor_resource + post: + description: 新建 + operationId: monitor_resource_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + monitor_resource: + $ref: '#/definitions/MonitorResourceCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_ValidateCreateDataOutput' + summary: 新建 + tags: + - monitor_resource + /monitor_resources/{id}: + delete: + description: 删除 + operationId: monitor_resource_CustomizeDelete + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_CustomizeDeleteOutput' + summary: 删除 + tags: + - monitor_resource + get: + description: 获取详情 + operationId: monitor_resource_FetchCustomizeColumns + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - monitor_resource + put: + description: 更新 + operationId: monitor_resource_ValidateUpdateData + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/VirtualResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_ValidateUpdateDataOutput' + summary: 更新 + tags: + - monitor_resource + /monitor_resources/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: monitor_resource_PerformCancelDelete + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - monitor_resource + /monitor_resources/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: monitor_resource_PerformChangeOwner + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - monitor_resource + /monitor_resources/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: monitor_resource_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - monitor_resource + /monitor_resources/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: monitor_resource_GetDetailsClassMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - monitor_resource + post: + description: 执行操作ClassMetadata + operationId: monitor_resource_PerformClassMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - monitor_resource + /monitor_resources/{id}/freeze: + post: + description: 执行操作Freeze + operationId: monitor_resource_PerformFreeze + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - monitor_resource + /monitor_resources/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: monitor_resource_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - monitor_resource + /monitor_resources/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: monitor_resource_PerformSetClassMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - monitor_resource + /monitor_resources/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: monitor_resource_PerformSetUserMetadata + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - monitor_resource + /monitor_resources/{id}/status: + get: + description: 获取指定信息Status + operationId: monitor_resource_GetDetailsStatus + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/monitor_resource_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - monitor_resource + post: + description: 执行操作Status + operationId: monitor_resource_PerformStatus + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformStatusOutput' + summary: 更新资源状态 + tags: + - monitor_resource + /monitor_resources/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: monitor_resource_PerformUnfreeze + parameters: + - description: The Id or Name of monitor_resource + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - monitor_resource + /monitor_resources/alert: + get: + description: 获取指定资源类的信息Alert + operationId: monitor_resource_GetPropertyAlert + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyAlertOutput' + summary: 获取指定资源类的信息Alert + tags: + - monitor_resource + /monitor_resources/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: monitor_resource_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - monitor_resource + /monitor_resources/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: monitor_resource_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - monitor_resource + /monitor_resources/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: monitor_resource_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - monitor_resource + /monitor_resources/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: monitor_resource_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - monitor_resource + /monitor_resources/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: monitor_resource_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - monitor_resource + /monitor_resources/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: monitor_resource_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + monitor_resource: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/monitor_resource_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - monitor_resource + /monitor_resources/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: monitor_resource_GetPropertySplitable + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - monitor_resource + /monitor_resources/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: monitor_resource_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - monitor_resource + /monitor_resources/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: monitor_resource_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - monitor_resource + /monitor_resources/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: monitor_resource_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - monitor_resource + /monitor_resources/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: monitor_resource_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/monitor_resource_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - monitor_resource + /node_alerts: + get: + description: 列表 + operationId: node_alert_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 监控指标名称 + in: query + name: metric + type: string + x-go-name: Metric + - description: '监控资源类型, 比如: guest, host' + in: query + name: type + type: string + x-go-name: Type + - description: 监控资源名称 + in: query + name: node_name + type: string + x-go-name: NodeName + - description: 监控资源 Id + in: query + name: node_id + type: string + x-go-name: NodeId + responses: + "200": + $ref: '#/responses/node_alert_ListItemFilterOutput' + summary: 列表 + tags: + - node_alert + post: + description: 新建 + operationId: node_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + node_alert: + $ref: '#/definitions/NodeAlertCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - node_alert + /node_alerts/{id}: + delete: + description: 删除 + operationId: node_alert_CustomizeDelete + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - node_alert + get: + description: 获取详情 + operationId: node_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - node_alert + put: + description: 更新 + operationId: node_alert_ValidateUpdateData + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - node_alert + /node_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: node_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - node_alert + post: + description: 执行操作ClassMetadata + operationId: node_alert_PerformClassMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - node_alert + /node_alerts/{id}/config: + post: + description: 执行操作Config + operationId: node_alert_PerformConfig + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_PerformConfigOutput' + summary: 执行操作Config + tags: + - node_alert + /node_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: node_alert_PerformDisable + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - node_alert + /node_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: node_alert_PerformEnable + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - node_alert + /node_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: node_alert_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - node_alert + /node_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: node_alert_PerformPause + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - node_alert + /node_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: node_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - node_alert + /node_alerts/{id}/set-scope: + post: + description: 执行操作SetScope + operationId: node_alert_PerformSetScope + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_PerformSetScopeOutput' + summary: 执行操作SetScope + tags: + - node_alert + /node_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: node_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - node_alert + /node_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: node_alert_GetDetailsStatus + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/node_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - node_alert + post: + description: 执行操作Status + operationId: node_alert_PerformStatus + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - node_alert + /node_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: node_alert_PerformTestRun + parameters: + - description: The Id or Name of node_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - node_alert + /node_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: node_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/node_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - node_alert + /node_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: node_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + node_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/node_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - node_alert + /node_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: node_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/node_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - node_alert + /node_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: node_alert_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/node_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - node_alert + /node_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: node_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/node_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - node_alert + /node_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: node_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/node_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - node_alert + /node_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: node_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/node_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - node_alert + /v1_alerts: + get: + description: 列表 + operationId: v1_alert_ListItemFilter + parameters: + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 指定匹配的范围，可能值为project, domain or system + in: query + name: belong_scope + type: string + x-go-name: BelongScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + responses: + "200": + $ref: '#/responses/v1_alert_ListItemFilterOutput' + summary: 列表 + tags: + - v1_alert + post: + description: 新建 + operationId: v1_alert_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + v1_alert: + $ref: '#/definitions/AlertCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_ValidateCreateDataOutput' + summary: 新建 + tags: + - v1_alert + /v1_alerts/{id}: + delete: + description: 删除 + operationId: v1_alert_CustomizeDelete + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_CustomizeDeleteOutput' + summary: 删除 + tags: + - v1_alert + get: + description: 获取详情 + operationId: v1_alert_FetchCustomizeColumns + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - v1_alert + put: + description: 更新 + operationId: v1_alert_ValidateUpdateData + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/V1AlertUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_ValidateUpdateDataOutput' + summary: 更新 + tags: + - v1_alert + /v1_alerts/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: v1_alert_GetDetailsClassMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - v1_alert + post: + description: 执行操作ClassMetadata + operationId: v1_alert_PerformClassMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - v1_alert + /v1_alerts/{id}/disable: + post: + description: 执行操作Disable + operationId: v1_alert_PerformDisable + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformDisableOutput' + summary: 执行操作Disable + tags: + - v1_alert + /v1_alerts/{id}/enable: + post: + description: 执行操作Enable + operationId: v1_alert_PerformEnable + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformEnableOutput' + summary: 执行操作Enable + tags: + - v1_alert + /v1_alerts/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: v1_alert_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - v1_alert + /v1_alerts/{id}/pause: + post: + description: 执行操作Pause + operationId: v1_alert_PerformPause + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertPauseInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformPauseOutput' + summary: 执行操作Pause + tags: + - v1_alert + /v1_alerts/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: v1_alert_PerformSetClassMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - v1_alert + /v1_alerts/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: v1_alert_PerformSetUserMetadata + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - v1_alert + /v1_alerts/{id}/status: + get: + description: 获取指定信息Status + operationId: v1_alert_GetDetailsStatus + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/v1_alert_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - v1_alert + post: + description: 执行操作Status + operationId: v1_alert_PerformStatus + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformStatusOutput' + summary: 更新资源状态 + tags: + - v1_alert + /v1_alerts/{id}/test-run: + post: + description: 执行操作TestRun + operationId: v1_alert_PerformTestRun + parameters: + - description: The Id or Name of v1_alert + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertTestRunInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformTestRunOutput' + summary: 执行操作TestRun + tags: + - v1_alert + /v1_alerts/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: v1_alert_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - v1_alert + /v1_alerts/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: v1_alert_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + v1_alert: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/v1_alert_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - v1_alert + /v1_alerts/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: v1_alert_GetPropertySplitable + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - v1_alert + /v1_alerts/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: v1_alert_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - v1_alert + /v1_alerts/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: v1_alert_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - v1_alert + /v1_alerts/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: v1_alert_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - v1_alert + /v1_alerts/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: v1_alert_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/v1_alert_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - v1_alert +produces: +- application/json +responses: + alert_CustomizeDeleteOutput: + schema: + properties: + alert: + $ref: '#/definitions/AlertDetails' + type: object + alert_FetchCustomizeColumnsOutput: + schema: + properties: + alert: + $ref: '#/definitions/AlertDetails' + type: object + alert_GetDetailsClassMetadataOutput: + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_GetDetailsMetadataOutput: + schema: + properties: + alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_GetDetailsStatusOutput: + schema: + properties: + alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_GetPropertyDistinctFieldOutput: {} + alert_GetPropertySplitableExportOutput: {} + alert_GetPropertySplitableOutput: {} + alert_GetPropertyStatisticsOutput: + schema: + properties: + alert: + $ref: '#/definitions/StatusStatistic' + type: object + alert_GetPropertyTagValuePairsOutput: {} + alert_GetPropertyTagValueTreeOutput: {} + alert_ListItemFilterOutput: + schema: + properties: + alerts: + items: + $ref: '#/definitions/AlertDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + alert_PerformClassMetadataOutput: {} + alert_PerformDisableOutput: {} + alert_PerformEnableOutput: {} + alert_PerformPauseOutput: {} + alert_PerformPurgeSplitableOutput: {} + alert_PerformSetClassMetadataOutput: {} + alert_PerformSetUserMetadataOutput: {} + alert_PerformStatusOutput: {} + alert_PerformTestRunOutput: + schema: + properties: + alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + alert_ValidateCreateDataOutput: + schema: + properties: + alert: + $ref: '#/definitions/AlertDetails' + type: object + alert_ValidateUpdateDataOutput: + schema: + properties: + alert: + $ref: '#/definitions/AlertDetails' + type: object + alert_dash_board_CustomizeDeleteOutput: + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardDetails' + type: object + alert_dash_board_FetchCustomizeColumnsOutput: + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardDetails' + type: object + alert_dash_board_GetDetailsClassMetadataOutput: + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_dash_board_GetDetailsMetadataOutput: + schema: + properties: + alert_dash_board: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_dash_board_GetDetailsStatusOutput: + schema: + properties: + alert_dash_board: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_dash_board_GetPropertyDistinctFieldOutput: {} + alert_dash_board_GetPropertySplitableExportOutput: {} + alert_dash_board_GetPropertySplitableOutput: {} + alert_dash_board_GetPropertyStatisticsOutput: + schema: + properties: + alert_dash_board: + $ref: '#/definitions/StatusStatistic' + type: object + alert_dash_board_GetPropertyTagValuePairsOutput: {} + alert_dash_board_GetPropertyTagValueTreeOutput: {} + alert_dash_board_ListItemFilterOutput: + schema: + properties: + alert_dash_boards: + items: + $ref: '#/definitions/AlertDashBoardDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + alert_dash_board_PerformClassMetadataOutput: {} + alert_dash_board_PerformCloneDashboardOutput: {} + alert_dash_board_PerformClonePanelOutput: {} + alert_dash_board_PerformPurgeSplitableOutput: {} + alert_dash_board_PerformSetClassMetadataOutput: {} + alert_dash_board_PerformSetScopeOutput: {} + alert_dash_board_PerformSetUserMetadataOutput: {} + alert_dash_board_PerformStatusOutput: {} + alert_dash_board_ValidateCreateDataOutput: + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardDetails' + type: object + alert_dash_board_ValidateUpdateDataOutput: + schema: + properties: + alert_dash_board: + $ref: '#/definitions/AlertDashBoardDetails' + type: object + alert_dashboard_panel_CustomizeDeleteOutput: + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + alert_dashboard_panel_FetchCustomizeColumnsOutput: + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + alert_dashboard_panel_GetPropertyDistinctFieldOutput: {} + alert_dashboard_panel_GetPropertySplitableExportOutput: {} + alert_dashboard_panel_GetPropertySplitableOutput: {} + alert_dashboard_panel_ListItemFilterOutput: + schema: + properties: + alert_dashboard_panels: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + alert_dashboard_panel_PerformPurgeSplitableOutput: {} + alert_dashboard_panel_ValidateCreateDataOutput: + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + alert_dashboard_panel_ValidateUpdateDataOutput: + schema: + properties: + alert_dashboard_panel: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + alert_notification_CustomizeDeleteOutput: + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceDetails' + type: object + alert_notification_FetchCustomizeColumnsOutput: + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceDetails' + type: object + alert_notification_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + alert_notification: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + alert_notification_GetDetailsClassMetadataOutput: + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_notification_GetDetailsMetadataOutput: + schema: + properties: + alert_notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_notification_GetDetailsStatusOutput: + schema: + properties: + alert_notification: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_notification_GetPropertyDistinctFieldOutput: {} + alert_notification_GetPropertyDomainStatisticsOutput: + schema: + properties: + alert_notification: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + alert_notification_GetPropertyProjectStatisticsOutput: + schema: + properties: + alert_notification: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + alert_notification_GetPropertyProjectTagValuePairsOutput: {} + alert_notification_GetPropertyProjectTagValueTreeOutput: {} + alert_notification_GetPropertySplitableExportOutput: {} + alert_notification_GetPropertySplitableOutput: {} + alert_notification_GetPropertyStatisticsOutput: + schema: + properties: + alert_notification: + $ref: '#/definitions/StatusStatistic' + type: object + alert_notification_GetPropertyTagValuePairsOutput: {} + alert_notification_GetPropertyTagValueTreeOutput: {} + alert_notification_ListItemFilterOutput: + schema: + properties: + alert_notifications: + items: + $ref: '#/definitions/VirtualResourceDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + alert_notification_PerformCancelDeleteOutput: {} + alert_notification_PerformChangeOwnerOutput: {} + alert_notification_PerformClassMetadataOutput: {} + alert_notification_PerformFreezeOutput: {} + alert_notification_PerformPurgeSplitableOutput: {} + alert_notification_PerformSetClassMetadataOutput: {} + alert_notification_PerformSetUserMetadataOutput: {} + alert_notification_PerformStatusOutput: {} + alert_notification_PerformUnfreezeOutput: {} + alert_notification_ValidateCreateDataOutput: + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceDetails' + type: object + alert_notification_ValidateUpdateDataOutput: + schema: + properties: + alert_notification: + $ref: '#/definitions/VirtualResourceDetails' + type: object + alert_panel_CustomizeDeleteOutput: + schema: + properties: + alert_panel: + $ref: '#/definitions/PanelDetails' + type: object + alert_panel_FetchCustomizeColumnsOutput: + schema: + properties: + alert_panel: + $ref: '#/definitions/PanelDetails' + type: object + alert_panel_GetDetailsClassMetadataOutput: + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_panel_GetDetailsMetadataOutput: + schema: + properties: + alert_panel: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_panel_GetDetailsStatusOutput: + schema: + properties: + alert_panel: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_panel_GetPropertyDistinctFieldOutput: {} + alert_panel_GetPropertySplitableExportOutput: {} + alert_panel_GetPropertySplitableOutput: {} + alert_panel_GetPropertyStatisticsOutput: + schema: + properties: + alert_panel: + $ref: '#/definitions/StatusStatistic' + type: object + alert_panel_GetPropertyTagValuePairsOutput: {} + alert_panel_GetPropertyTagValueTreeOutput: {} + alert_panel_ListItemFilterOutput: + schema: + properties: + alert_panels: + items: + $ref: '#/definitions/PanelDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + alert_panel_PerformClassMetadataOutput: {} + alert_panel_PerformPurgeSplitableOutput: {} + alert_panel_PerformSetClassMetadataOutput: {} + alert_panel_PerformSetUserMetadataOutput: {} + alert_panel_PerformStatusOutput: {} + alert_panel_ValidateCreateDataOutput: + schema: + properties: + alert_panel: + $ref: '#/definitions/PanelDetails' + type: object + alert_panel_ValidateUpdateDataOutput: + schema: + properties: + alert_panel: + $ref: '#/definitions/PanelDetails' + type: object + alert_record_CustomizeDeleteOutput: + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordDetails' + type: object + alert_record_FetchCustomizeColumnsOutput: + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordDetails' + type: object + alert_record_GetDetailsClassMetadataOutput: + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_GetDetailsMetadataOutput: + schema: + properties: + alert_record: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_GetDetailsStatusOutput: + schema: + properties: + alert_record: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_record_GetPropertyDistinctFieldOutput: {} + alert_record_GetPropertySplitableExportOutput: {} + alert_record_GetPropertySplitableOutput: {} + alert_record_GetPropertyStatisticsOutput: + schema: + properties: + alert_record: + $ref: '#/definitions/StatusStatistic' + type: object + alert_record_GetPropertyTagValuePairsOutput: {} + alert_record_GetPropertyTagValueTreeOutput: {} + alert_record_GetPropertyTotalAlertOutput: {} + alert_record_ListItemFilterOutput: + schema: + properties: + alert_records: + items: + $ref: '#/definitions/AlertRecordDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + alert_record_PerformClassMetadataOutput: {} + alert_record_PerformPurgeSplitableOutput: {} + alert_record_PerformSetClassMetadataOutput: {} + alert_record_PerformSetUserMetadataOutput: {} + alert_record_PerformStatusOutput: {} + alert_record_ValidateCreateDataOutput: + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordDetails' + type: object + alert_record_ValidateUpdateDataOutput: + schema: + properties: + alert_record: + $ref: '#/definitions/AlertRecordDetails' + type: object + alert_record_shield_CustomizeDeleteOutput: + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldDetails' + type: object + alert_record_shield_FetchCustomizeColumnsOutput: + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldDetails' + type: object + alert_record_shield_GetDetailsClassMetadataOutput: + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_shield_GetDetailsMetadataOutput: + schema: + properties: + alert_record_shield: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_record_shield_GetDetailsStatusOutput: + schema: + properties: + alert_record_shield: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + alert_record_shield_GetPropertyDistinctFieldOutput: {} + alert_record_shield_GetPropertySplitableExportOutput: {} + alert_record_shield_GetPropertySplitableOutput: {} + alert_record_shield_GetPropertyStatisticsOutput: + schema: + properties: + alert_record_shield: + $ref: '#/definitions/StatusStatistic' + type: object + alert_record_shield_GetPropertyTagValuePairsOutput: {} + alert_record_shield_GetPropertyTagValueTreeOutput: {} + alert_record_shield_ListItemFilterOutput: + schema: + properties: + alert_record_shields: + items: + $ref: '#/definitions/AlertRecordShieldDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + alert_record_shield_PerformClassMetadataOutput: {} + alert_record_shield_PerformPurgeSplitableOutput: {} + alert_record_shield_PerformSetClassMetadataOutput: {} + alert_record_shield_PerformSetUserMetadataOutput: {} + alert_record_shield_PerformStatusOutput: {} + alert_record_shield_ValidateCreateDataOutput: + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldDetails' + type: object + alert_record_shield_ValidateUpdateDataOutput: + schema: + properties: + alert_record_shield: + $ref: '#/definitions/AlertRecordShieldDetails' + type: object + alert_resource_CustomizeDeleteOutput: + schema: + properties: + alert_resource: + $ref: '#/definitions/AlertResourceDetails' + type: object + alert_resource_FetchCustomizeColumnsOutput: + schema: + properties: + alert_resource: + $ref: '#/definitions/AlertResourceDetails' + type: object + alert_resource_GetDetailsClassMetadataOutput: + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_resource_GetDetailsMetadataOutput: + schema: + properties: + alert_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + alert_resource_GetPropertyDistinctFieldOutput: {} + alert_resource_GetPropertySplitableExportOutput: {} + alert_resource_GetPropertySplitableOutput: {} + alert_resource_GetPropertyTagValuePairsOutput: {} + alert_resource_GetPropertyTagValueTreeOutput: {} + alert_resource_ListItemFilterOutput: + schema: + properties: + alert_resources: + items: + $ref: '#/definitions/AlertResourceDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + alert_resource_PerformClassMetadataOutput: {} + alert_resource_PerformPurgeSplitableOutput: {} + alert_resource_PerformSetClassMetadataOutput: {} + alert_resource_PerformSetUserMetadataOutput: {} + alert_resource_ValidateCreateDataOutput: + schema: + properties: + alert_resource: + $ref: '#/definitions/AlertResourceDetails' + type: object + alert_resource_ValidateUpdateDataOutput: + schema: + properties: + alert_resource: + $ref: '#/definitions/AlertResourceDetails' + type: object + alert_resource_alert_CustomizeDeleteOutput: {} + alert_resource_alert_FetchCustomizeColumnsOutput: {} + alert_resource_alert_GetPropertyDistinctFieldOutput: {} + alert_resource_alert_GetPropertySplitableExportOutput: {} + alert_resource_alert_GetPropertySplitableOutput: {} + alert_resource_alert_ListItemFilterOutput: {} + alert_resource_alert_PerformPurgeSplitableOutput: {} + alert_resource_alert_ValidateCreateDataOutput: {} + alert_resource_alert_ValidateUpdateDataOutput: {} + common_alert_CustomizeDeleteOutput: + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertDetails' + type: object + common_alert_FetchCustomizeColumnsOutput: + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertDetails' + type: object + common_alert_GetDetailsClassMetadataOutput: + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + common_alert_GetDetailsMetadataOutput: + schema: + properties: + common_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + common_alert_GetDetailsStatusOutput: + schema: + properties: + common_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + common_alert_GetPropertyDistinctFieldOutput: {} + common_alert_GetPropertySplitableExportOutput: {} + common_alert_GetPropertySplitableOutput: {} + common_alert_GetPropertyStatisticsOutput: + schema: + properties: + common_alert: + $ref: '#/definitions/StatusStatistic' + type: object + common_alert_GetPropertyTagValuePairsOutput: {} + common_alert_GetPropertyTagValueTreeOutput: {} + common_alert_ListItemFilterOutput: + schema: + properties: + common_alerts: + items: + $ref: '#/definitions/CommonAlertDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + common_alert_PerformClassMetadataOutput: {} + common_alert_PerformConfigOutput: {} + common_alert_PerformDisableOutput: {} + common_alert_PerformEnableOutput: {} + common_alert_PerformPauseOutput: {} + common_alert_PerformPurgeSplitableOutput: {} + common_alert_PerformSetClassMetadataOutput: {} + common_alert_PerformSetScopeOutput: {} + common_alert_PerformSetUserMetadataOutput: {} + common_alert_PerformStatusOutput: {} + common_alert_PerformTestRunOutput: + schema: + properties: + common_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + common_alert_ValidateCreateDataOutput: + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertDetails' + type: object + common_alert_ValidateUpdateDataOutput: + schema: + properties: + common_alert: + $ref: '#/definitions/CommonAlertDetails' + type: object + data_source_CustomizeDeleteOutput: + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + data_source_FetchCustomizeColumnsOutput: + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + data_source_GetDetailsClassMetadataOutput: + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + data_source_GetDetailsMetadataOutput: + schema: + properties: + data_source: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + data_source_GetPropertyDistinctFieldOutput: {} + data_source_GetPropertySplitableExportOutput: {} + data_source_GetPropertySplitableOutput: {} + data_source_GetPropertyTagValuePairsOutput: {} + data_source_GetPropertyTagValueTreeOutput: {} + data_source_ListItemFilterOutput: + schema: + properties: + data_sources: + items: + $ref: '#/definitions/StandaloneResourceDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + data_source_PerformClassMetadataOutput: {} + data_source_PerformPurgeSplitableOutput: {} + data_source_PerformSetClassMetadataOutput: {} + data_source_PerformSetUserMetadataOutput: {} + data_source_ValidateCreateDataOutput: + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + data_source_ValidateUpdateDataOutput: + schema: + properties: + data_source: + $ref: '#/definitions/StandaloneResourceDetails' + type: object + meter_alert_CustomizeDeleteOutput: + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertDetails' + type: object + meter_alert_FetchCustomizeColumnsOutput: + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertDetails' + type: object + meter_alert_GetDetailsClassMetadataOutput: + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + meter_alert_GetDetailsMetadataOutput: + schema: + properties: + meter_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + meter_alert_GetDetailsStatusOutput: + schema: + properties: + meter_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + meter_alert_GetPropertyDistinctFieldOutput: {} + meter_alert_GetPropertySplitableExportOutput: {} + meter_alert_GetPropertySplitableOutput: {} + meter_alert_GetPropertyStatisticsOutput: + schema: + properties: + meter_alert: + $ref: '#/definitions/StatusStatistic' + type: object + meter_alert_GetPropertyTagValuePairsOutput: {} + meter_alert_GetPropertyTagValueTreeOutput: {} + meter_alert_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + meter_alerts: + items: + $ref: '#/definitions/MeterAlertDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + meter_alert_PerformClassMetadataOutput: {} + meter_alert_PerformDisableOutput: {} + meter_alert_PerformEnableOutput: {} + meter_alert_PerformPauseOutput: {} + meter_alert_PerformPurgeSplitableOutput: {} + meter_alert_PerformSetClassMetadataOutput: {} + meter_alert_PerformSetUserMetadataOutput: {} + meter_alert_PerformStatusOutput: {} + meter_alert_PerformTestRunOutput: + schema: + properties: + meter_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + meter_alert_ValidateCreateDataOutput: + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertDetails' + type: object + meter_alert_ValidateUpdateDataOutput: + schema: + properties: + meter_alert: + $ref: '#/definitions/MeterAlertDetails' + type: object + metric_CustomizeDeleteOutput: + schema: + properties: + metric: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + metric_FetchCustomizeColumnsOutput: + schema: + properties: + metric: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + metric_GetPropertyDistinctFieldOutput: {} + metric_GetPropertySplitableExportOutput: {} + metric_GetPropertySplitableOutput: {} + metric_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + metrics: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + metric_PerformPurgeSplitableOutput: {} + metric_ValidateCreateDataOutput: + schema: + properties: + metric: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + metric_ValidateUpdateDataOutput: + schema: + properties: + metric: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + metric_field_CustomizeDeleteOutput: + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldDetail' + type: object + metric_field_FetchCustomizeColumnsOutput: + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldDetail' + type: object + metric_field_GetDetailsClassMetadataOutput: + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_field_GetDetailsMetadataOutput: + schema: + properties: + metric_field: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_field_GetDetailsStatusOutput: + schema: + properties: + metric_field: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + metric_field_GetPropertyDistinctFieldOutput: {} + metric_field_GetPropertySplitableExportOutput: {} + metric_field_GetPropertySplitableOutput: {} + metric_field_GetPropertyStatisticsOutput: + schema: + properties: + metric_field: + $ref: '#/definitions/StatusStatistic' + type: object + metric_field_GetPropertyTagValuePairsOutput: {} + metric_field_GetPropertyTagValueTreeOutput: {} + metric_field_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + metric_fields: + items: + $ref: '#/definitions/MetricFieldDetail' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + metric_field_PerformClassMetadataOutput: {} + metric_field_PerformPurgeSplitableOutput: {} + metric_field_PerformSetClassMetadataOutput: {} + metric_field_PerformSetUserMetadataOutput: {} + metric_field_PerformStatusOutput: {} + metric_field_ValidateCreateDataOutput: + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldDetail' + type: object + metric_field_ValidateUpdateDataOutput: + schema: + properties: + metric_field: + $ref: '#/definitions/MetricFieldDetail' + type: object + metric_measurement_CustomizeDeleteOutput: + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricDetails' + type: object + metric_measurement_FetchCustomizeColumnsOutput: + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricDetails' + type: object + metric_measurement_GetDetailsClassMetadataOutput: + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_measurement_GetDetailsMetadataOutput: + schema: + properties: + metric_measurement: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + metric_measurement_GetDetailsStatusOutput: + schema: + properties: + metric_measurement: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + metric_measurement_GetPropertyDistinctFieldOutput: {} + metric_measurement_GetPropertySplitableExportOutput: {} + metric_measurement_GetPropertySplitableOutput: {} + metric_measurement_GetPropertyStatisticsOutput: + schema: + properties: + metric_measurement: + $ref: '#/definitions/StatusStatistic' + type: object + metric_measurement_GetPropertyTagValuePairsOutput: {} + metric_measurement_GetPropertyTagValueTreeOutput: {} + metric_measurement_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + metric_measurements: + items: + $ref: '#/definitions/MetricDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + metric_measurement_PerformClassMetadataOutput: {} + metric_measurement_PerformPurgeSplitableOutput: {} + metric_measurement_PerformSetClassMetadataOutput: {} + metric_measurement_PerformSetUserMetadataOutput: {} + metric_measurement_PerformStatusOutput: {} + metric_measurement_ValidateCreateDataOutput: + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricDetails' + type: object + metric_measurement_ValidateUpdateDataOutput: + schema: + properties: + metric_measurement: + $ref: '#/definitions/MetricDetails' + type: object + migration_alert_CustomizeDeleteOutput: + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertDetails' + type: object + migration_alert_FetchCustomizeColumnsOutput: + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertDetails' + type: object + migration_alert_GetDetailsClassMetadataOutput: + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + migration_alert_GetDetailsMetadataOutput: + schema: + properties: + migration_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + migration_alert_GetDetailsStatusOutput: + schema: + properties: + migration_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + migration_alert_GetPropertyDistinctFieldOutput: {} + migration_alert_GetPropertySplitableExportOutput: {} + migration_alert_GetPropertySplitableOutput: {} + migration_alert_GetPropertyStatisticsOutput: + schema: + properties: + migration_alert: + $ref: '#/definitions/StatusStatistic' + type: object + migration_alert_GetPropertyTagValuePairsOutput: {} + migration_alert_GetPropertyTagValueTreeOutput: {} + migration_alert_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + migration_alerts: + items: + $ref: '#/definitions/AlertDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + migration_alert_PerformClassMetadataOutput: {} + migration_alert_PerformDisableOutput: {} + migration_alert_PerformEnableOutput: {} + migration_alert_PerformPauseOutput: {} + migration_alert_PerformPurgeSplitableOutput: {} + migration_alert_PerformSetClassMetadataOutput: {} + migration_alert_PerformSetUserMetadataOutput: {} + migration_alert_PerformStatusOutput: {} + migration_alert_PerformTestRunOutput: + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + migration_alert_ValidateCreateDataOutput: + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertDetails' + type: object + migration_alert_ValidateUpdateDataOutput: + schema: + properties: + migration_alert: + $ref: '#/definitions/AlertDetails' + type: object + monitor_resource_CustomizeDeleteOutput: + schema: + properties: + monitor_resource: + $ref: '#/definitions/MonitorResourceDetails' + type: object + monitor_resource_FetchCustomizeColumnsOutput: + schema: + properties: + monitor_resource: + $ref: '#/definitions/MonitorResourceDetails' + type: object + monitor_resource_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + monitor_resource: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + monitor_resource_GetDetailsClassMetadataOutput: + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + monitor_resource_GetDetailsMetadataOutput: + schema: + properties: + monitor_resource: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + monitor_resource_GetDetailsStatusOutput: + schema: + properties: + monitor_resource: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + monitor_resource_GetPropertyAlertOutput: {} + monitor_resource_GetPropertyDistinctFieldOutput: {} + monitor_resource_GetPropertyDomainStatisticsOutput: + schema: + properties: + monitor_resource: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + monitor_resource_GetPropertyProjectStatisticsOutput: + schema: + properties: + monitor_resource: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + monitor_resource_GetPropertyProjectTagValuePairsOutput: {} + monitor_resource_GetPropertyProjectTagValueTreeOutput: {} + monitor_resource_GetPropertySplitableExportOutput: {} + monitor_resource_GetPropertySplitableOutput: {} + monitor_resource_GetPropertyStatisticsOutput: + schema: + properties: + monitor_resource: + $ref: '#/definitions/StatusStatistic' + type: object + monitor_resource_GetPropertyTagValuePairsOutput: {} + monitor_resource_GetPropertyTagValueTreeOutput: {} + monitor_resource_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + monitor_resources: + items: + $ref: '#/definitions/MonitorResourceDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + monitor_resource_PerformCancelDeleteOutput: {} + monitor_resource_PerformChangeOwnerOutput: {} + monitor_resource_PerformClassMetadataOutput: {} + monitor_resource_PerformFreezeOutput: {} + monitor_resource_PerformPurgeSplitableOutput: {} + monitor_resource_PerformSetClassMetadataOutput: {} + monitor_resource_PerformSetUserMetadataOutput: {} + monitor_resource_PerformStatusOutput: {} + monitor_resource_PerformUnfreezeOutput: {} + monitor_resource_ValidateCreateDataOutput: + schema: + properties: + monitor_resource: + $ref: '#/definitions/MonitorResourceDetails' + type: object + monitor_resource_ValidateUpdateDataOutput: + schema: + properties: + monitor_resource: + $ref: '#/definitions/MonitorResourceDetails' + type: object + monitor_resource_alert_CustomizeDeleteOutput: + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/MonitorResourceJointDetails' + type: object + monitor_resource_alert_FetchCustomizeColumnsOutput: + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/MonitorResourceJointDetails' + type: object + monitor_resource_alert_GetPropertyDistinctFieldOutput: {} + monitor_resource_alert_GetPropertySplitableExportOutput: {} + monitor_resource_alert_GetPropertySplitableOutput: {} + monitor_resource_alert_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + monitor_resource_alerts: + items: + $ref: '#/definitions/MonitorResourceJointDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + monitor_resource_alert_PerformPurgeSplitableOutput: {} + monitor_resource_alert_ValidateCreateDataOutput: + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/MonitorResourceJointDetails' + type: object + monitor_resource_alert_ValidateUpdateDataOutput: + schema: + properties: + monitor_resource_alert: + $ref: '#/definitions/MonitorResourceJointDetails' + type: object + node_alert_CustomizeDeleteOutput: + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertDetails' + type: object + node_alert_FetchCustomizeColumnsOutput: + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertDetails' + type: object + node_alert_GetDetailsClassMetadataOutput: + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + node_alert_GetDetailsMetadataOutput: + schema: + properties: + node_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + node_alert_GetDetailsStatusOutput: + schema: + properties: + node_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + node_alert_GetPropertyDistinctFieldOutput: {} + node_alert_GetPropertySplitableExportOutput: {} + node_alert_GetPropertySplitableOutput: {} + node_alert_GetPropertyStatisticsOutput: + schema: + properties: + node_alert: + $ref: '#/definitions/StatusStatistic' + type: object + node_alert_GetPropertyTagValuePairsOutput: {} + node_alert_GetPropertyTagValueTreeOutput: {} + node_alert_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + node_alerts: + items: + $ref: '#/definitions/NodeAlertDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + node_alert_PerformClassMetadataOutput: {} + node_alert_PerformConfigOutput: {} + node_alert_PerformDisableOutput: {} + node_alert_PerformEnableOutput: {} + node_alert_PerformPauseOutput: {} + node_alert_PerformPurgeSplitableOutput: {} + node_alert_PerformSetClassMetadataOutput: {} + node_alert_PerformSetScopeOutput: {} + node_alert_PerformSetUserMetadataOutput: {} + node_alert_PerformStatusOutput: {} + node_alert_PerformTestRunOutput: + schema: + properties: + node_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + node_alert_ValidateCreateDataOutput: + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertDetails' + type: object + node_alert_ValidateUpdateDataOutput: + schema: + properties: + node_alert: + $ref: '#/definitions/NodeAlertDetails' + type: object + v1_alert_CustomizeDeleteOutput: + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertV1Details' + type: object + v1_alert_FetchCustomizeColumnsOutput: + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertV1Details' + type: object + v1_alert_GetDetailsClassMetadataOutput: + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + v1_alert_GetDetailsMetadataOutput: + schema: + properties: + v1_alert: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + v1_alert_GetDetailsStatusOutput: + schema: + properties: + v1_alert: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + v1_alert_GetPropertyDistinctFieldOutput: {} + v1_alert_GetPropertySplitableExportOutput: {} + v1_alert_GetPropertySplitableOutput: {} + v1_alert_GetPropertyStatisticsOutput: + schema: + properties: + v1_alert: + $ref: '#/definitions/StatusStatistic' + type: object + v1_alert_GetPropertyTagValuePairsOutput: {} + v1_alert_GetPropertyTagValueTreeOutput: {} + v1_alert_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + v1_alerts: + items: + $ref: '#/definitions/AlertV1Details' + type: array + x-go-name: Output + type: object + v1_alert_PerformClassMetadataOutput: {} + v1_alert_PerformDisableOutput: {} + v1_alert_PerformEnableOutput: {} + v1_alert_PerformPauseOutput: {} + v1_alert_PerformPurgeSplitableOutput: {} + v1_alert_PerformSetClassMetadataOutput: {} + v1_alert_PerformSetUserMetadataOutput: {} + v1_alert_PerformStatusOutput: {} + v1_alert_PerformTestRunOutput: + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertTestRunOutput' + type: object + v1_alert_ValidateCreateDataOutput: + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertV1Details' + type: object + v1_alert_ValidateUpdateDataOutput: + schema: + properties: + v1_alert: + $ref: '#/definitions/AlertV1Details' + type: object +schemes: +- https +- http +securityDefinitions: + keystone: + in: header + name: X-Auth-Token + type: apiKey +swagger: "2.0" diff --git a/docs/swagger/swagger_notify.yaml b/docs/swagger/swagger_notify.yaml new file mode 100644 index 0000000000..de056c676a --- /dev/null +++ b/docs/swagger/swagger_notify.yaml @@ -0,0 +1,8911 @@ +basePath: / +consumes: +- application/json +definitions: + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ConfigCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + attribution: + description: 'description: attribution' + enum: + - system + - domain + example: system + type: string + x-go-name: Attribution + content: + $ref: '#/definitions/SNotifyConfigContent' + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: + description: 'description: config type' + example: feishu + type: string + x-go-name: Type + required: + - name + - type + - content + - attribution + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigDetails: + properties: + attribution: + type: string + x-go-name: Attribution + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + content: + $ref: '#/definitions/SNotifyConfigContent' + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigManagerGetTypesInput: + properties: + domain_ids: + description: 'description: View the available notification channels for the + domains with these DomainIds' + items: + type: string + type: array + x-go-name: DomainIds + operation: + description: 'description: Operation of reduce' + enum: + - union + - merge + type: string + x-go-name: Operation + receivers: + description: 'description: View the available notification channels for the + receivers' + items: + type: string + type: array + x-go-name: Receivers + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigManagerGetTypesOutput: + properties: + types: + items: + type: string + type: array + x-go-name: Types + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigUpdateInput: + properties: + content: + $ref: '#/definitions/SNotifyConfigContent' + required: + - content + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigValidateInput: + properties: + content: + $ref: '#/definitions/SNotifyConfigContent' + type: + description: 'description: config type' + example: feishu + type: string + x-go-name: Type + required: + - type + - content + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ConfigValidateOutput: + properties: + is_valid: + type: boolean + x-go-name: IsValid + message: + type: string + x-go-name: Message + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + EmailQueueCreateInput: + properties: + attachments: + items: + $ref: '#/definitions/SEmailAttachment' + type: array + x-go-name: Attachments + bcc: + items: + type: string + type: array + x-go-name: Bcc + body: + type: string + x-go-name: Body + cc: + items: + type: string + type: array + x-go-name: Cc + content: + description: 'swagger: ignore' + type: object + x-go-name: Content + dest: + description: 'swagger: ignore' + type: string + x-go-name: Dest + dest_bcc: + description: 'swagger: ignore' + type: string + x-go-name: DestBcc + dest_cc: + description: 'swagger: ignore' + type: string + x-go-name: DestCc + domain: + description: 'swagger: ignore' + type: string + x-go-name: Domain + domain_id: + description: 'swagger: ignore' + type: string + x-go-name: DomainId + project: + description: 'swagger: ignore' + type: string + x-go-name: Project + project_domain: + description: 'swagger: ignore' + type: string + x-go-name: ProjectDomain + project_domain_id: + description: 'swagger: ignore' + type: string + x-go-name: ProjectDomainId + project_id: + description: 'swagger: ignore' + type: string + x-go-name: ProjectId + roles: + description: 'swagger: ignore' + type: string + x-go-name: Roles + session_id: + type: string + x-go-name: SessionId + subject: + type: string + x-go-name: Subject + to: + items: + type: string + type: array + x-go-name: To + user: + description: 'swagger: ignore' + type: string + x-go-name: User + user_id: + description: 'swagger: ignore' + type: string + x-go-name: UserId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + EmailQueueDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + content: + type: object + x-go-name: Content + delete_fail_reason: + $ref: '#/definitions/Error' + dest: + type: string + x-go-name: Dest + dest_bcc: + type: string + x-go-name: DestBcc + dest_cc: + type: string + x-go-name: DestCc + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + format: int64 + type: integer + x-go-name: Id + project: + type: string + x-go-name: Project + project_domain: + type: string + x-go-name: ProjectDomain + project_domain_id: + type: string + x-go-name: ProjectDomainId + project_id: + type: string + x-go-name: ProjectId + recv_at: + format: date-time + type: string + x-go-name: RecvAt + results: + type: string + x-go-name: Results + roles: + type: string + x-go-name: Roles + sent_at: + format: date-time + type: string + x-go-name: SentAt + session_id: + type: string + x-go-name: SessionId + status: + type: string + x-go-name: Status + subject: + type: string + x-go-name: Subject + update_fail_reason: + $ref: '#/definitions/Error' + user: + type: string + x-go-name: User + user_id: + type: string + x-go-name: UserId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + EmailQueueSendInput: + properties: + sync: + type: boolean + x-go-name: Sync + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + FailedElem: + properties: + ContactType: + type: string + Reason: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + GetDetailsStatusOutput: + properties: + status: + description: 状态 + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + Identification: + properties: + id: + example: 036fed49483b412888a760c2bc995caa + type: string + x-go-name: ID + name: + example: test + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + JoinResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + JointResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ModelBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ModelBaseDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ModelBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + NotificationCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + contact_type: + description: |- + description: contact type + required: ture + example: email + type: string + x-go-name: ContactType + contacts: + description: 'description: direct contact, admin privileges required' + items: + type: string + type: array + x-go-name: Contacts + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + ignore_nonexistent_receiver: + type: boolean + x-go-name: IgnoreNonexistentReceiver + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + message: + description: |- + description: message content or jsonobject + required: ture + type: string + x-go-name: Message + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + priority: + description: 'description: notification priority' + enum: + - fatal + - important + - nomal + example: normal + type: string + x-go-name: Priority + receivers: + description: 'description: ids or names of receiver' + example: '{"adfb720ccdd34c638346ea4fa7a713a8", "zhangsan"}' + items: + type: string + type: array + x-go-name: Receivers + robots: + description: 'description: robots' + example: feishu robot + items: + type: string + type: array + x-go-name: Robots + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + tag: + description: 'description: notification tag' + example: alert + type: string + x-go-name: Tag + topic: + description: 'description: notification topic' + example: IMAGE_ACTIVE + type: string + x-go-name: Topic + required: + - name + - topic + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + NotificationDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + contact_type: + type: string + x-go-name: ContactType + content: + type: string + x-go-name: Content + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + event_id: + type: string + x-go-name: EventId + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + priority: + type: string + x-go-name: Priority + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + receive_details: + items: + $ref: '#/definitions/ReceiveDetail' + type: array + x-go-name: ReceiveDetails + received_at: + format: date-time + type: string + x-go-name: ReceivedAt + send_times: + format: int64 + type: integer + x-go-name: SendTimes + status: + description: 资源状态 + type: string + x-go-name: Status + title: + type: string + x-go-name: Title + topic_type: + type: string + x-go-name: TopicType + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + NotificationManagerEventNotifyInput: + properties: + Action: + $ref: '#/definitions/SAction' + CloudAccountName: + type: string + Event: + description: 'description: event trigger sending notification' + example: SERVER_DELETE + type: string + IsFailed: + $ref: '#/definitions/SResult' + ProjectDomainId: + description: 'description: domainId of the resource that triggered the event + notification' + example: default + type: string + ResourceType: + type: string + Result: + $ref: '#/definitions/SResult' + advance_days: + description: 'description: day left before the event' + example: 0 + format: int64 + type: integer + x-go-name: AdvanceDays + contact_type: + description: 'description: contact types' + example: email + items: + type: string + type: array + x-go-name: ContactTypes + contacts: + description: 'description: direct contact, admin privileges required' + items: + $ref: '#/definitions/SContact' + type: array + x-go-name: Contacts + priority: + description: 'description: notification priority' + enum: + - fatal + - important + - nomal + example: normal + type: string + x-go-name: Priority + project_id: + description: 'description: projectId of the resource that triggered the event + notification' + example: f627e09f038645f08ce6880c8d9cb8fd + type: string + x-go-name: ProjectId + receiver_ids: + description: 'description: ids or names of receiver' + example: '{"adfb720ccdd34c638346ea4fa7a713a8"}' + items: + type: string + type: array + x-go-name: ReceiverIds + resource_details: + description: |- + description: resource details + required: ture + type: object + x-go-name: ResourceDetails + required: + - Event + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + NotificationManagerEventNotifyOutput: + properties: + FailedList: + items: + $ref: '#/definitions/FailedElem' + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + PerformChangeDomainOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformChangeProjectOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformDisableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformEnableInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformFreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicProjectInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + shared_project_ids: + description: 如果共享范围为项目，则在此列表中指定共享的目标项目 + items: + type: string + type: array + x-go-name: SharedProjectIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformStatusInput: + properties: + host_id: + description: call from host id + type: string + x-go-name: HostId + power_states: + description: 电源状态 + type: string + x-go-name: PowerStates + reason: + description: 更改状态的原因描述 + type: string + x-go-name: Reason + status: + description: 更改的目标状态值 + type: string + x-go-name: Status + required: + - status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformUnfreezeInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ProjectStatistic: + properties: + Count: + format: int64 + type: integer + Id: + type: string + Name: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ReceiveDetail: + properties: + contact: + type: string + x-go-name: Contact + failed_reason: + type: string + x-go-name: FailedReason + receiver_id: + type: string + x-go-name: ReceiverId + receiver_name: + type: string + x-go-name: ReceiverName + receiver_type: + type: string + x-go-name: ReceiverType + send_by: + type: string + x-go-name: SendBy + sendAt: + format: date-time + type: string + x-go-name: SendAt + status: + type: string + x-go-name: Status + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + email: + description: 'description: user email' + example: example@gmail.com + type: string + x-go-name: Email + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + enabled_contact_types: + description: 'description: enabled contact types for user' + example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}' + items: + type: string + type: array + x-go-name: EnabledContactTypes + force_verified: + description: force verified if admin create the records + type: boolean + x-go-name: ForceVerified + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + international_mobile: + $ref: '#/definitions/SInternationalMobile' + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + uid: + description: 'description: user id in keystone' + example: adfb720ccdd34c638346ea4fa7a713a8 + type: string + x-go-name: UID + uname: + description: 'description: user name in keystone' + example: hello + type: string + x-go-name: UName + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + email: + type: string + x-go-name: Email + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + enabled_contact_types: + description: 'description: enabled contact types for user' + example: eamil, mobile, feishu, dingtalk, workwx + items: + type: string + type: array + x-go-name: EnabledContactTypes + id: + description: 资源UUID + type: string + x-go-name: Id + international_mobile: + $ref: '#/definitions/SInternationalMobile' + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + lang: + type: string + x-go-name: Lang + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + status: + description: 资源状态 + type: string + x-go-name: Status + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + verified_infos: + description: 'description: verified info' + items: + $ref: '#/definitions/VerifiedInfo' + type: array + x-go-name: VerifiedInfos + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverEnableContactTypeInput: + properties: + enabled_contact_types: + items: + type: string + type: array + x-go-name: EnabledContactTypes + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverIntellijGetInput: + properties: + create_if_no: + description: 'description: create if receiver with UserId does not exist' + type: boolean + x-go-name: CreateIfNo + scope: + description: 'description: scope' + type: string + x-go-name: Scope + user_id: + description: 'description: user id in keystone' + type: string + x-go-name: UserId + required: + - user_id + - scope + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverTriggerVerifyInput: + properties: + contact_type: + description: 'description: contact type' + enum: + - email + - mobile + example: email + type: string + x-go-name: ContactType + required: + - contact_type + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + email: + description: 'description: user email' + example: example@gmail.com + type: string + x-go-name: Email + enabled_contact_types: + description: 'description: enabled contacts for user' + example: '{"email", "mobile", "feishu", "dingtalk", "workwx"}' + items: + type: string + type: array + x-go-name: EnabledContactTypes + force_verified: + type: boolean + x-go-name: ForceVerified + international_mobile: + $ref: '#/definitions/SInternationalMobile' + name: + description: 资源名称 + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + ReceiverVerifyInput: + properties: + contact_type: + description: 'description: Contact type' + enum: + - email + - mobile + example: email + type: string + x-go-name: ContactType + token: + description: 'description: token user input' + example: "123456" + type: string + x-go-name: Token + required: + - contact_type + - token + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + RobotCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + address: + description: 'description: address' + example: http://helloworld.io/test/webhook + type: string + x-go-name: Address + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + disabled: + description: 该资源是否被管理员*人为*禁用, 和enabled互斥 + type: boolean + x-go-name: Disabled + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + enabled: + description: 该资源是否被管理员*人为*启用或者禁用 + type: boolean + x-go-name: Enabled + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + is_system: + description: 'description: indicate the resource is a system resource, which + is not visible to user' + type: boolean + x-go-name: IsSystem + lang: + description: 'description: Language preference' + example: zh_CN + type: string + x-go-name: Lang + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + project_id: + description: 指定项目的名称或ID + type: string + x-go-name: ProjectId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + status: + description: 用来存储资源的状态 + type: string + x-go-name: Status + type: + description: 'description: robot type' + enum: + - feishu + - dingtalk + - workwx + - webhook + example: webhook + type: string + x-go-name: Type + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + RobotDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + project: + description: |- + 资源归属项目的名称（向后兼容别名） + Deprecated + type: string + x-go-name: Tenant + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + project_id: + description: |- + 资源归属项目的ID(向后兼容别名） + Deprecated + type: string + x-go-name: TenantId + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + tenant: + description: |- + 资源归属项目的名称 + alias:project + type: string + x-go-name: Project + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + RobotUpdateInput: + properties: + address: + description: 'description: address' + example: http://helloworld.io/test/webhook + type: string + x-go-name: Address + description: + description: 资源描述 + type: string + x-go-name: Description + lang: + description: 'description: Language preference' + example: en + type: string + x-go-name: Lang + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SAction: + type: string + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SContact: + properties: + contact: + type: string + x-go-name: Contact + contact_type: + type: string + x-go-name: ContactType + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SEmailAttachment: + properties: + content: + type: string + x-go-name: Base64Content + filename: + type: string + x-go-name: Filename + mime: + type: string + x-go-name: Mime + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SInternationalMobile: + properties: + area_code: + description: 'description: area code of mobile' + example: "86" + type: string + x-go-name: AreaCode + mobile: + description: 'description: user mobile' + example: "17812345678" + type: string + x-go-name: Mobile + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SNotifyConfigContent: + properties: + AccessKeyId: + description: sms + type: string + AccessKeySecret: + type: string + AccessToken: + type: string + AgentId: + description: workwx + type: string + AppId: + description: Lark + type: string + AppKey: + description: |- + dingtalk + AgentId string + AppSecret string + type: string + AppSecret: + type: string + CorpId: + type: string + Hostname: + description: Email + type: string + Hostport: + format: int64 + type: integer + Password: + type: string + Secret: + type: string + SenderAddress: + type: string + ServiceUrl: + type: string + Signature: + type: string + SmsDriver: + type: string + SslGlobal: + type: boolean + Username: + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SResult: + type: string + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + SharedDomain: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedProject: + properties: + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneAnonResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StandaloneAnonResourceDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStandaloneResourceBaseUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + format: float + type: number + x-go-name: Progress + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatistic: + properties: + TotalCpuCount: + description: CPU总量 + format: int64 + type: integer + TotalDiskSizeMb: + description: 存储总量 + format: int64 + type: integer + TotalMemSizeMb: + description: 内存总量 + format: int64 + type: integer + status_info: + items: + $ref: '#/definitions/StatusStatisticStatusInfo' + type: array + x-go-name: StatusInfo + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + StatusStatisticStatusInfo: + properties: + Status: + type: string + pending_deleted_count: + description: |- + 回收站数量 + 需要指定pending_delete=all + format: int64 + type: integer + x-go-name: PendingDeletedCount + total_count: + description: 资源总数 + format: int64 + type: integer + x-go-name: TotalCount + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SubscriberChangeInput: + properties: + Receivers: + description: 'description: receivers which is required when the type is ''receiver'' + will Subscribe TopicID' + items: + type: string + type: array + Robot: + description: 'description: Robot(Id or Name) which is required when the type + is ''robot'' will Subscribe TopicID' + type: string + Role: + description: 'description: Role(Id or Name) which is required when the type + is ''role'' will Subscribe TopicID' + type: string + RoleScope: + description: 'description: The scope of role subscribers' + enum: + - system + - domain + - project + type: string + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SubscriberCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + DomainId: + description: 'description: domain id of resource' + example: 1e3824756bac4ac084e784ed297ec652 + type: string + Receivers: + description: 'description: receivers which is required when the type is ''receiver'' + will Subscribe TopicID' + items: + type: string + type: array + ResourceAttributionId: + description: 'description: project id or domain id of resource' + example: 1e3824756bac4ac084e784ed297ec652 + type: string + ResourceAttributionName: + type: string + ResourceScope: + description: 'description: scope of resource' + enum: + - system + - domain + - project + type: string + Robot: + description: 'description: Robot(Id or Name) which is required when the type + is ''robot'' will Subscribe TopicID' + type: string + Role: + description: 'description: Role(Id or Name) which is required when the type + is ''role'' will Subscribe TopicID' + type: string + RoleScope: + description: 'description: The scope of role subscribers' + enum: + - system + - domain + - project + type: string + Scope: + description: 'description: scope' + enum: + - system + - domain + type: string + TopicID: + description: |- + description: Id of Topic + required + type: string + Type: + description: 'description: Type of subscriber' + enum: + - receiver + - robot + - role + type: string + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SubscriberDetails: + properties: + Receivers: + description: 'description: receivers' + items: + $ref: '#/definitions/Identification' + type: array + Robot: + $ref: '#/definitions/Identification' + Role: + $ref: '#/definitions/Identification' + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + type: string + x-go-name: DomainId + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + id: + description: 资源UUID + type: string + x-go-name: Id + identification: + type: string + x-go-name: Identification + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + resource_attribution_id: + type: string + x-go-name: ResourceAttributionId + resource_attribution_name: + type: string + x-go-name: ResourceAttributionName + resource_scope: + type: string + x-go-name: ResourceScope + role_scope: + type: string + x-go-name: RoleScope + scope: + type: string + x-go-name: Scope + topic_id: + type: string + x-go-name: TopicId + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + SubscriberSetReceiverInput: + properties: + Receivers: + items: + type: string + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TTagSet: + items: + $ref: '#/definitions/STag' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TemplateCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + contact_type: + description: |- + description: Contact type, specifically, setting it to all means all contact type + require: true + example: email + type: string + x-go-name: ContactType + content: + description: 'description: Template content' + example: 镜像 {{.name}} 上传完成 + type: string + x-go-name: Content + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + example: + description: 'description: Example for using this template' + example: '{"name": "centos7.6"}' + type: string + x-go-name: Example + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + lang: + description: 'description: Language' + enum: + - cn + - en + type: string + x-go-name: Lang + template_type: + description: 'description: Template type' + enum: + - title + - content + - remote + example: title + type: string + x-go-name: TemplateType + topic: + description: 'description: Template topic' + example: IMAGE_ACTIVE + type: string + x-go-name: Topic + required: + - topic + - content + - example + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TemplateManagerSaveInput: + properties: + ContactType: + type: string + Force: + type: boolean + Templates: + items: + $ref: '#/definitions/TemplateCreateInput' + type: array + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TemplateUpdateInput: + properties: + content: + description: 'description: template content' + example: 镜像 {{.name}} 上传完成 + type: string + x-go-name: Content + description: + description: 资源描述 + type: string + x-go-name: Description + example: + description: 'description: all example for using this template' + example: '{"name": "centos7.6"}' + type: string + x-go-name: Example + required: + - content + - example + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + TopicDetails: + properties: + actions: + format: uint32 + type: integer + x-go-name: Actions + advance_days: + format: int64 + type: integer + x-go-name: AdvanceDays + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + content_cn: + type: string + x-go-name: ContentCn + content_en: + type: string + x-go-name: ContentEn + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + enabled: + description: 资源是否启用 + type: boolean + x-go-name: Enabled + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + progress: + description: 操作进度0-100 + format: float + type: number + x-go-name: Progress + resource_types: + description: 'description: resources managed' + example: + - server + - eip + - disk + items: + type: string + type: array + x-go-name: Resources + resources: + format: uint64 + type: integer + x-go-name: Resources + results: + type: boolean + x-go-name: Results + status: + description: 资源状态 + type: string + x-go-name: Status + title_cn: + type: string + x-go-name: TitleCn + title_en: + type: string + x-go-name: TitleEn + type: + type: string + x-go-name: Type + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + webconsole_disable: + type: boolean + x-go-name: WebconsoleDisable + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify + VerifiedInfo: + properties: + ContactType: + type: string + Note: + type: string + Verified: + type: boolean + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/notify +host: '"127.0.0.1:8889"' +info: + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Notify API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" +paths: + /configs: + get: + description: 列表 + operationId: config_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - in: query + name: type + type: string + x-go-name: Type + - in: query + name: attribution + type: string + x-go-name: Attribution + responses: + "200": + $ref: '#/responses/config_ListItemFilterOutput' + summary: 列表 + tags: + - config + post: + description: 新建 + operationId: config_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/ConfigCreateInput' + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_ValidateCreateDataOutput' + summary: 新建 + tags: + - config + /configs/{id}: + delete: + description: 删除 + operationId: config_CustomizeDelete + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_CustomizeDeleteOutput' + summary: 删除 + tags: + - config + get: + description: 获取详情 + operationId: config_FetchCustomizeColumns + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - config + put: + description: 更新 + operationId: config_ValidateUpdateData + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/ConfigUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_ValidateUpdateDataOutput' + summary: 更新 + tags: + - config + /configs/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: config_PerformChangeOwner + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - config + /configs/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: config_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - config + /configs/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: config_GetDetailsClassMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - config + post: + description: 执行操作ClassMetadata + operationId: config_PerformClassMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - config + /configs/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: config_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/config_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - config + /configs/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: config_PerformSetClassMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - config + /configs/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: config_PerformSetUserMetadata + parameters: + - description: The Id or Name of config + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - config + /configs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: config_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/config_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - config + /configs/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: config_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/config_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - config + /configs/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: config_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/config_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - config + /configs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: config_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - config + /configs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: config_GetPropertySplitable + responses: + "200": + $ref: '#/responses/config_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - config + /configs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: config_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/config_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - config + /configs/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: config_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/config_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - config + /configs/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: config_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/config_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - config + /configs/validate: + post: + description: 执行操作Validate + operationId: config_PerformValidate + parameters: + - in: body + name: body + schema: + properties: + config: + $ref: '#/definitions/ConfigValidateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/config_PerformValidateOutput' + summary: 执行操作Validate + tags: + - config + /email_queue_statuses: + get: + description: 列表 + operationId: email_queue_status_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/email_queue_status_ListItemFilterOutput' + summary: 列表 + tags: + - email_queue_status + post: + description: 新建 + operationId: email_queue_status_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + email_queue_status: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_status_ValidateCreateDataOutput' + summary: 新建 + tags: + - email_queue_status + /email_queue_statuses/{id}: + delete: + description: 删除 + operationId: email_queue_status_CustomizeDelete + parameters: + - description: The Id or Name of email_queue_status + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_status_CustomizeDeleteOutput' + summary: 删除 + tags: + - email_queue_status + get: + description: 获取详情 + operationId: email_queue_status_FetchCustomizeColumns + parameters: + - description: The Id or Name of email_queue_status + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_status_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - email_queue_status + put: + description: 更新 + operationId: email_queue_status_ValidateUpdateData + parameters: + - description: The Id or Name of email_queue_status + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_status_ValidateUpdateDataOutput' + summary: 更新 + tags: + - email_queue_status + /email_queue_statuses/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: email_queue_status_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/email_queue_status_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - email_queue_status + /email_queue_statuses/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: email_queue_status_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + email_queue_status: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_status_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - email_queue_status + /email_queue_statuses/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: email_queue_status_GetPropertySplitable + responses: + "200": + $ref: '#/responses/email_queue_status_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - email_queue_status + /email_queue_statuses/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: email_queue_status_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/email_queue_status_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - email_queue_status + /email_queues: + get: + description: 列表 + operationId: email_queue_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - in: query + items: + format: int64 + type: integer + name: id + type: array + x-go-name: Id + - in: query + items: + type: string + name: to + type: array + x-go-name: To + - in: query + name: subject + type: string + x-go-name: Subject + - in: query + items: + type: string + name: session_id + type: array + x-go-name: SessionId + responses: + "200": + $ref: '#/responses/email_queue_ListItemFilterOutput' + summary: 宿主机/物理机列表 + tags: + - email_queue + post: + description: 新建 + operationId: email_queue_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + email_queue: + $ref: '#/definitions/EmailQueueCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_ValidateCreateDataOutput' + summary: 新建 + tags: + - email_queue + /email_queues/{id}: + delete: + description: 删除 + operationId: email_queue_CustomizeDelete + parameters: + - description: The Id or Name of email_queue + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_CustomizeDeleteOutput' + summary: 删除 + tags: + - email_queue + get: + description: 获取详情 + operationId: email_queue_FetchCustomizeColumns + parameters: + - description: The Id or Name of email_queue + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - email_queue + put: + description: 更新 + operationId: email_queue_ValidateUpdateData + parameters: + - description: The Id or Name of email_queue + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/email_queue_ValidateUpdateDataOutput' + summary: 更新 + tags: + - email_queue + /email_queues/{id}/send: + post: + description: 执行操作Send + operationId: email_queue_PerformSend + parameters: + - description: The Id or Name of email_queue + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueSendInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_PerformSendOutput' + summary: 执行操作Send + tags: + - email_queue + /email_queues/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: email_queue_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/email_queue_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - email_queue + /email_queues/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: email_queue_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + email_queue: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/email_queue_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - email_queue + /email_queues/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: email_queue_GetPropertySplitable + responses: + "200": + $ref: '#/responses/email_queue_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - email_queue + /email_queues/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: email_queue_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/email_queue_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - email_queue + /events: + get: + description: 列表 + operationId: event_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/event_ListItemFilterOutput' + summary: 列表 + tags: + - event + post: + description: 新建 + operationId: event_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + event: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/event_ValidateCreateDataOutput' + summary: 新建 + tags: + - event + /events/{id}: + delete: + description: 删除 + operationId: event_CustomizeDelete + parameters: + - description: The Id or Name of event + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/event_CustomizeDeleteOutput' + summary: 删除 + tags: + - event + get: + description: 获取详情 + operationId: event_FetchCustomizeColumns + parameters: + - description: The Id or Name of event + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/event_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - event + put: + description: 更新 + operationId: event_ValidateUpdateData + parameters: + - description: The Id or Name of event + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/event_ValidateUpdateDataOutput' + summary: 更新 + tags: + - event + /events/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: event_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/event_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - event + /events/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: event_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + event: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/event_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - event + /events/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: event_GetPropertySplitable + responses: + "200": + $ref: '#/responses/event_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - event + /events/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: event_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/event_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - event + /notification_logs: + get: + description: 列表 + operationId: notification_log_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/notification_log_ListItemFilterOutput' + summary: 列表 + tags: + - notification_log + post: + description: 新建 + operationId: notification_log_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + notification_log: + $ref: '#/definitions/ModelBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_log_ValidateCreateDataOutput' + summary: 新建 + tags: + - notification_log + /notification_logs/{id}: + delete: + description: 删除 + operationId: notification_log_CustomizeDelete + parameters: + - description: The Id or Name of notification_log + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_log_CustomizeDeleteOutput' + summary: 删除 + tags: + - notification_log + get: + description: 获取详情 + operationId: notification_log_FetchCustomizeColumns + parameters: + - description: The Id or Name of notification_log + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_log_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - notification_log + put: + description: 更新 + operationId: notification_log_ValidateUpdateData + parameters: + - description: The Id or Name of notification_log + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_log_ValidateUpdateDataOutput' + summary: 更新 + tags: + - notification_log + /notification_logs/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: notification_log_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/notification_log_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - notification_log + /notification_logs/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: notification_log_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + notification_log: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_log_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - notification_log + /notification_logs/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: notification_log_GetPropertySplitable + responses: + "200": + $ref: '#/responses/notification_log_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - notification_log + /notification_logs/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: notification_log_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/notification_log_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - notification_log + /notifications: + get: + description: 列表 + operationId: notification_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - in: query + name: ContactType + type: string + - in: query + name: ReceiverId + type: string + - in: query + name: Tag + type: string + - in: query + name: TopicType + type: string + responses: + "200": + $ref: '#/responses/notification_ListItemFilterOutput' + summary: 通知消息列表 + tags: + - notification + post: + description: 新建 + operationId: notification_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + notification: + $ref: '#/definitions/NotificationCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_ValidateCreateDataOutput' + summary: 新建 + tags: + - notification + /notifications/{id}: + delete: + description: 删除 + operationId: notification_CustomizeDelete + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_CustomizeDeleteOutput' + summary: 删除 + tags: + - notification + get: + description: 获取详情 + operationId: notification_FetchCustomizeColumns + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - notification + put: + description: 更新 + operationId: notification_ValidateUpdateData + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/StatusStandaloneResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_ValidateUpdateDataOutput' + summary: 更新 + tags: + - notification + /notifications/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: notification_GetDetailsClassMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - notification + post: + description: 执行操作ClassMetadata + operationId: notification_PerformClassMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - notification + /notifications/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: notification_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - notification + /notifications/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: notification_PerformSetClassMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - notification + /notifications/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: notification_PerformSetUserMetadata + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - notification + /notifications/{id}/status: + get: + description: 获取指定信息Status + operationId: notification_GetDetailsStatus + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/notification_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - notification + post: + description: 执行操作Status + operationId: notification_PerformStatus + parameters: + - description: The Id or Name of notification + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformStatusOutput' + summary: 更新资源状态 + tags: + - notification + /notifications/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: notification_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/notification_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - notification + /notifications/event-notify: + post: + description: 执行操作EventNotify + operationId: notification_PerformEventNotify + parameters: + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/NotificationManagerEventNotifyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformEventNotifyOutput' + summary: 'TODO: support project and domain' + tags: + - notification + /notifications/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: notification_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + notification: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/notification_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - notification + /notifications/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: notification_GetPropertySplitable + responses: + "200": + $ref: '#/responses/notification_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - notification + /notifications/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: notification_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/notification_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - notification + /notifications/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: notification_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/notification_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - notification + /notifications/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: notification_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/notification_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - notification + /notifications/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: notification_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/notification_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - notification + /receivers: + get: + description: 列表 + operationId: receiver_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - in: query + name: uid + type: string + x-go-name: UID + - in: query + name: uname + type: string + x-go-name: UName + - in: query + name: enabled_contact_type + type: string + x-go-name: EnabledContactType + - in: query + name: verified_contact_type + type: string + x-go-name: VerifiedContactType + - in: query + name: project_domain_filter + type: boolean + x-go-name: ProjectDomainFilter + responses: + "200": + $ref: '#/responses/receiver_ListItemFilterOutput' + summary: 列表 + tags: + - receiver + post: + description: 新建 + operationId: receiver_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + receiver: + $ref: '#/definitions/ReceiverCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_ValidateCreateDataOutput' + summary: 新建 + tags: + - receiver + /receivers/{id}: + delete: + description: 删除 + operationId: receiver_CustomizeDelete + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_CustomizeDeleteOutput' + summary: 删除 + tags: + - receiver + get: + description: 获取详情 + operationId: receiver_FetchCustomizeColumns + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - receiver + put: + description: 更新 + operationId: receiver_ValidateUpdateData + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_ValidateUpdateDataOutput' + summary: 更新 + tags: + - receiver + /receivers/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: receiver_PerformChangeOwner + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - receiver + /receivers/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: receiver_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - receiver + /receivers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: receiver_GetDetailsClassMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - receiver + post: + description: 执行操作ClassMetadata + operationId: receiver_PerformClassMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - receiver + /receivers/{id}/disable: + post: + description: 执行操作Disable + operationId: receiver_PerformDisable + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformDisableOutput' + summary: 执行操作Disable + tags: + - receiver + /receivers/{id}/enable: + post: + description: 执行操作Enable + operationId: receiver_PerformEnable + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformEnableOutput' + summary: 执行操作Enable + tags: + - receiver + /receivers/{id}/enable-contact-type: + post: + description: 执行操作EnableContactType + operationId: receiver_PerformEnableContactType + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverEnableContactTypeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformEnableContactTypeOutput' + summary: 执行操作EnableContactType + tags: + - receiver + /receivers/{id}/get-subscription: + post: + description: 执行操作GetSubscription + operationId: receiver_PerformGetSubscription + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverIntellijGetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformGetSubscriptionOutput' + summary: 获取用户订阅 + tags: + - receiver + /receivers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: receiver_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - receiver + /receivers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: receiver_PerformSetClassMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - receiver + /receivers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: receiver_PerformSetUserMetadata + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - receiver + /receivers/{id}/status: + get: + description: 获取指定信息Status + operationId: receiver_GetDetailsStatus + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/receiver_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - receiver + post: + description: 执行操作Status + operationId: receiver_PerformStatus + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformStatusOutput' + summary: 更新资源状态 + tags: + - receiver + /receivers/{id}/trigger-verify: + post: + description: 执行操作TriggerVerify + operationId: receiver_PerformTriggerVerify + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverTriggerVerifyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformTriggerVerifyOutput' + summary: 执行操作TriggerVerify + tags: + - receiver + /receivers/{id}/verify: + post: + description: 执行操作Verify + operationId: receiver_PerformVerify + parameters: + - description: The Id or Name of receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverVerifyInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformVerifyOutput' + summary: 执行操作Verify + tags: + - receiver + /receivers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: receiver_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/receiver_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - receiver + /receivers/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: receiver_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/receiver_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - receiver + /receivers/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: receiver_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/receiver_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - receiver + /receivers/get-types: + post: + description: 执行操作GetTypes + operationId: receiver_PerformGetTypes + parameters: + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ConfigManagerGetTypesInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformGetTypesOutput' + summary: 执行操作GetTypes + tags: + - receiver + /receivers/intellij-get: + post: + description: 执行操作IntellijGet + operationId: receiver_PerformIntellijGet + parameters: + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverIntellijGetInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformIntellijGetOutput' + summary: 执行操作IntellijGet + tags: + - receiver + /receivers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: receiver_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + receiver: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/receiver_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - receiver + /receivers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: receiver_GetPropertySplitable + responses: + "200": + $ref: '#/responses/receiver_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - receiver + /receivers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: receiver_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/receiver_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - receiver + /receivers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: receiver_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/receiver_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - receiver + /receivers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: receiver_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/receiver_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - receiver + /robots: + get: + description: 列表 + operationId: robot_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源的状态过滤列表 + in: query + items: + type: string + name: status + type: array + x-go-name: Status + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 指定项目的名称或ID + in: query + name: project_id + type: string + x-go-name: ProjectId + - description: 对具有项目属性的资源，严格匹配项目ID + in: query + items: + type: string + name: project_ids + type: array + x-go-name: ProjectIds + - description: 按project名称排序，可能值为asc|desc + in: query + name: order_by_project + pattern: asc|desc + type: string + x-go-name: OrderByProject + - $ref: '#/definitions/TTagSetList' + description: filter by project tags + in: query + name: project_tags + x-go-name: ProjectTags + - $ref: '#/definitions/TTagSetList' + description: filter by no project tags + in: query + name: no_project_tags + x-go-name: NoProjectTags + - $ref: '#/definitions/TTagSetList' + description: |- + ignore + project tag fitlers imposed by policy + in: query + name: policy_project_tags + x-go-name: PolicyProjectTags + - description: 列表中包含标记为"系统资源"的资源 + in: query + name: system + type: boolean + x-go-name: System + - description: 是否显示回收站内的资源，默认不显示（对实现了回收站的资源有效，例如主机，磁盘，镜像） + in: query + name: pending_delete + type: boolean + x-go-name: PendingDelete + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 'description: robot type' + enum: + - feishu + - dingtalk + - workwx + - webhook + example: webhook + in: query + name: type + type: string + x-go-name: Type + - description: 'description: Language preference' + example: en + in: query + name: lang + type: string + x-go-name: Lang + responses: + "200": + $ref: '#/responses/robot_ListItemFilterOutput' + summary: 列表 + tags: + - robot + post: + description: 新建 + operationId: robot_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + robot: + $ref: '#/definitions/RobotCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_ValidateCreateDataOutput' + summary: 新建 + tags: + - robot + /robots/{id}: + delete: + description: 删除 + operationId: robot_CustomizeDelete + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_CustomizeDeleteOutput' + summary: 删除 + tags: + - robot + get: + description: 获取详情 + operationId: robot_FetchCustomizeColumns + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - robot + put: + description: 更新 + operationId: robot_ValidateUpdateData + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/RobotUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_ValidateUpdateDataOutput' + summary: 更新 + tags: + - robot + /robots/{id}/cancel-delete: + post: + description: 执行操作CancelDelete + operationId: robot_PerformCancelDelete + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_PerformCancelDeleteOutput' + summary: 执行操作CancelDelete + tags: + - robot + /robots/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: robot_PerformChangeOwner + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformChangeProjectOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - robot + /robots/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: robot_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - robot + /robots/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: robot_GetDetailsClassMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - robot + post: + description: 执行操作ClassMetadata + operationId: robot_PerformClassMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - robot + /robots/{id}/disable: + post: + description: 执行操作Disable + operationId: robot_PerformDisable + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformDisableOutput' + summary: 执行操作Disable + tags: + - robot + /robots/{id}/enable: + post: + description: 执行操作Enable + operationId: robot_PerformEnable + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformEnableOutput' + summary: 执行操作Enable + tags: + - robot + /robots/{id}/freeze: + post: + description: 执行操作Freeze + operationId: robot_PerformFreeze + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformFreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformFreezeOutput' + summary: freezed update and perform action operation except for unfreeze + tags: + - robot + /robots/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: robot_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - robot + /robots/{id}/private: + post: + description: 执行操作Private + operationId: robot_PerformPrivate + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformPrivateOutput' + summary: 执行操作Private + tags: + - robot + /robots/{id}/public: + post: + description: 执行操作Public + operationId: robot_PerformPublic + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformPublicProjectInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformPublicOutput' + summary: 执行操作Public + tags: + - robot + /robots/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: robot_PerformSetClassMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - robot + /robots/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: robot_PerformSetUserMetadata + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - robot + /robots/{id}/status: + get: + description: 获取指定信息Status + operationId: robot_GetDetailsStatus + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/robot_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - robot + post: + description: 执行操作Status + operationId: robot_PerformStatus + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformStatusOutput' + summary: 更新资源状态 + tags: + - robot + /robots/{id}/unfreeze: + post: + description: 执行操作Unfreeze + operationId: robot_PerformUnfreeze + parameters: + - description: The Id or Name of robot + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PerformUnfreezeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformUnfreezeOutput' + summary: 执行操作Unfreeze + tags: + - robot + /robots/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: robot_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/robot_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - robot + /robots/domain-statistics: + get: + description: 获取指定资源类的信息DomainStatistics + operationId: robot_GetPropertyDomainStatistics + responses: + "200": + $ref: '#/responses/robot_GetPropertyDomainStatisticsOutput' + summary: 获取指定资源类的信息DomainStatistics + tags: + - robot + /robots/project-statistics: + get: + description: 获取指定资源类的信息ProjectStatistics + operationId: robot_GetPropertyProjectStatistics + responses: + "200": + $ref: '#/responses/robot_GetPropertyProjectStatisticsOutput' + summary: 获取指定资源类的信息ProjectStatistics + tags: + - robot + /robots/project-tag-value-pairs: + get: + description: 获取指定资源类的信息ProjectTagValuePairs + operationId: robot_GetPropertyProjectTagValuePairs + responses: + "200": + $ref: '#/responses/robot_GetPropertyProjectTagValuePairsOutput' + summary: 获取指定资源类的信息ProjectTagValuePairs + tags: + - robot + /robots/project-tag-value-tree: + get: + description: 获取指定资源类的信息ProjectTagValueTree + operationId: robot_GetPropertyProjectTagValueTree + responses: + "200": + $ref: '#/responses/robot_GetPropertyProjectTagValueTreeOutput' + summary: 获取指定资源类的信息ProjectTagValueTree + tags: + - robot + /robots/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: robot_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + robot: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/robot_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - robot + /robots/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: robot_GetPropertySplitable + responses: + "200": + $ref: '#/responses/robot_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - robot + /robots/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: robot_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/robot_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - robot + /robots/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: robot_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/robot_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - robot + /robots/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: robot_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/robot_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - robot + /robots/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: robot_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/robot_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - robot + /subscriber_receivers: + get: + description: 列表 + operationId: subscriber_receiver_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + responses: + "200": + $ref: '#/responses/subscriber_receiver_ListItemFilterOutput' + summary: 列表 + tags: + - subscriber_receiver + post: + description: 新建 + operationId: subscriber_receiver_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + subscriber_receiver: + $ref: '#/definitions/JoinResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_receiver_ValidateCreateDataOutput' + summary: 新建 + tags: + - subscriber_receiver + /subscriber_receivers/{id}: + delete: + description: 删除 + operationId: subscriber_receiver_CustomizeDelete + parameters: + - description: The Id or Name of subscriber_receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_receiver_CustomizeDeleteOutput' + summary: 删除 + tags: + - subscriber_receiver + get: + description: 获取详情 + operationId: subscriber_receiver_FetchCustomizeColumns + parameters: + - description: The Id or Name of subscriber_receiver + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_receiver_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - subscriber_receiver + put: + description: 更新 + operationId: subscriber_receiver_ValidateUpdateData + parameters: + - description: The Id or Name of subscriber_receiver + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_receiver_ValidateUpdateDataOutput' + summary: 更新 + tags: + - subscriber_receiver + /subscriber_receivers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: subscriber_receiver_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/subscriber_receiver_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - subscriber_receiver + /subscriber_receivers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: subscriber_receiver_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_receiver_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - subscriber_receiver + /subscriber_receivers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: subscriber_receiver_GetPropertySplitable + responses: + "200": + $ref: '#/responses/subscriber_receiver_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - subscriber_receiver + /subscriber_receivers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: subscriber_receiver_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/subscriber_receiver_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - subscriber_receiver + /subscribers: + get: + description: 列表 + operationId: subscriber_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + - description: 'description: topic id' + in: query + name: TopicID + type: string + - description: 'description: scope of resource' + enum: + - system + - domain + - project + in: query + name: ResourceScope + type: string + - description: 'description: type' + enum: + - receiver + - robot + - role + in: query + name: Type + type: string + - description: 'description: scope' + enum: + - system + - domain + in: query + name: Scope + type: string + responses: + "200": + $ref: '#/responses/subscriber_ListItemFilterOutput' + summary: 列表 + tags: + - subscriber + post: + description: 新建 + operationId: subscriber_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + subscriber: + $ref: '#/definitions/SubscriberCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_ValidateCreateDataOutput' + summary: 新建 + tags: + - subscriber + /subscribers/{id}: + delete: + description: 删除 + operationId: subscriber_CustomizeDelete + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_CustomizeDeleteOutput' + summary: 删除 + tags: + - subscriber + get: + description: 获取详情 + operationId: subscriber_FetchCustomizeColumns + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - subscriber + put: + description: 更新 + operationId: subscriber_ValidateUpdateData + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + $ref: '#/definitions/StandaloneAnonResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_ValidateUpdateDataOutput' + summary: 更新 + tags: + - subscriber + /subscribers/{id}/change: + post: + description: 执行操作Change + operationId: subscriber_PerformChange + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberChangeInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformChangeOutput' + summary: 执行操作Change + tags: + - subscriber + /subscribers/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: subscriber_GetDetailsClassMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - subscriber + post: + description: 执行操作ClassMetadata + operationId: subscriber_PerformClassMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - subscriber + /subscribers/{id}/disable: + post: + description: 执行操作Disable + operationId: subscriber_PerformDisable + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_PerformDisableOutput' + summary: 执行操作Disable + tags: + - subscriber + /subscribers/{id}/enable: + post: + description: 执行操作Enable + operationId: subscriber_PerformEnable + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_PerformEnableOutput' + summary: 执行操作Enable + tags: + - subscriber + /subscribers/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: subscriber_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/subscriber_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - subscriber + /subscribers/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: subscriber_PerformSetClassMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - subscriber + /subscribers/{id}/set-receiver: + post: + description: 执行操作SetReceiver + operationId: subscriber_PerformSetReceiver + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberSetReceiverInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformSetReceiverOutput' + summary: 执行操作SetReceiver + tags: + - subscriber + /subscribers/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: subscriber_PerformSetUserMetadata + parameters: + - description: The Id or Name of subscriber + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - subscriber + /subscribers/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: subscriber_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/subscriber_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - subscriber + /subscribers/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: subscriber_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + subscriber: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/subscriber_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - subscriber + /subscribers/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: subscriber_GetPropertySplitable + responses: + "200": + $ref: '#/responses/subscriber_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - subscriber + /subscribers/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: subscriber_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/subscriber_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - subscriber + /subscribers/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: subscriber_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/subscriber_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - subscriber + /subscribers/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: subscriber_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/subscriber_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - subscriber + /templates: + get: + description: 列表 + operationId: template_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: |- + description: Contact type, specifically, setting it to all means all contact type + require: true + example: email + in: query + name: contact_type + type: string + x-go-name: ContactType + - description: 'description: Template type' + enum: + - title + - content + - remote + example: title + in: query + name: template_type + type: string + x-go-name: TemplateType + - description: 'description: template topic' + example: IMAGE_ACTIVE + in: query + name: topic + required: true + type: string + x-go-name: Topic + - description: 'description: Language' + enum: + - cn + - en + in: query + name: lang + type: string + x-go-name: Lang + responses: + "200": + $ref: '#/responses/template_ListItemFilterOutput' + summary: 列表 + tags: + - template + post: + description: 新建 + operationId: template_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + template: + $ref: '#/definitions/TemplateCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_ValidateCreateDataOutput' + summary: 新建 + tags: + - template + /templates/{id}: + delete: + description: 删除 + operationId: template_CustomizeDelete + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_CustomizeDeleteOutput' + summary: 删除 + tags: + - template + get: + description: 获取详情 + operationId: template_FetchCustomizeColumns + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - template + put: + description: 更新 + operationId: template_ValidateUpdateData + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + $ref: '#/definitions/TemplateUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_ValidateUpdateDataOutput' + summary: 更新 + tags: + - template + /templates/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: template_GetDetailsClassMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - template + post: + description: 执行操作ClassMetadata + operationId: template_PerformClassMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - template + /templates/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: template_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/template_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - template + /templates/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: template_PerformSetClassMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - template + /templates/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: template_PerformSetUserMetadata + parameters: + - description: The Id or Name of template + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - template + /templates/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: template_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/template_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - template + /templates/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: template_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + template: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - template + /templates/save: + post: + description: 执行操作Save + operationId: template_PerformSave + parameters: + - in: body + name: body + schema: + properties: + template: + $ref: '#/definitions/TemplateManagerSaveInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/template_PerformSaveOutput' + summary: 执行操作Save + tags: + - template + /templates/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: template_GetPropertySplitable + responses: + "200": + $ref: '#/responses/template_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - template + /templates/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: template_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/template_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - template + /templates/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: template_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/template_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - template + /templates/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: template_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/template_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - template + /topics: + get: + description: 列表 + operationId: topic_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 以资源是否启用/禁用过滤列表 + in: query + name: enabled + type: boolean + x-go-name: Enabled + responses: + "200": + $ref: '#/responses/topic_ListItemFilterOutput' + summary: 列表 + tags: + - topic + post: + description: 新建 + operationId: topic_ValidateCreateData + responses: + "200": + $ref: '#/responses/topic_ValidateCreateDataOutput' + summary: 新建 + tags: + - topic + /topics/{id}: + delete: + description: 删除 + operationId: topic_CustomizeDelete + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_CustomizeDeleteOutput' + summary: 删除 + tags: + - topic + get: + description: 获取详情 + operationId: topic_FetchCustomizeColumns + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - topic + put: + description: 更新 + operationId: topic_ValidateUpdateData + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_ValidateUpdateDataOutput' + summary: 更新 + tags: + - topic + /topics/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: topic_GetDetailsClassMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - topic + post: + description: 执行操作ClassMetadata + operationId: topic_PerformClassMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - topic + /topics/{id}/disable: + post: + description: 执行操作Disable + operationId: topic_PerformDisable + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/PerformDisableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformDisableOutput' + summary: 禁用资源 + tags: + - topic + /topics/{id}/enable: + post: + description: 执行操作Enable + operationId: topic_PerformEnable + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/PerformEnableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformEnableOutput' + summary: 启用资源 + tags: + - topic + /topics/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: topic_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - topic + /topics/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: topic_PerformSetClassMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - topic + /topics/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: topic_PerformSetUserMetadata + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - topic + /topics/{id}/status: + get: + description: 获取指定信息Status + operationId: topic_GetDetailsStatus + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/topic_GetDetailsStatusOutput' + summary: 获取资源状态 + tags: + - topic + post: + description: 执行操作Status + operationId: topic_PerformStatus + parameters: + - description: The Id or Name of topic + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/PerformStatusInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformStatusOutput' + summary: 更新资源状态 + tags: + - topic + /topics/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: topic_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/topic_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - topic + /topics/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: topic_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + topic: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/topic_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - topic + /topics/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: topic_GetPropertySplitable + responses: + "200": + $ref: '#/responses/topic_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - topic + /topics/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: topic_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/topic_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - topic + /topics/statistics: + get: + description: 获取指定资源类的信息Statistics + operationId: topic_GetPropertyStatistics + responses: + "200": + $ref: '#/responses/topic_GetPropertyStatisticsOutput' + summary: 获取指定资源类的信息Statistics + tags: + - topic + /topics/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: topic_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/topic_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - topic + /topics/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: topic_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/topic_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - topic +produces: +- application/json +responses: + config_CustomizeDeleteOutput: + schema: + properties: + config: + $ref: '#/definitions/ConfigDetails' + type: object + config_FetchCustomizeColumnsOutput: + schema: + properties: + config: + $ref: '#/definitions/ConfigDetails' + type: object + config_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + config: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + config_GetDetailsClassMetadataOutput: + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + config_GetDetailsMetadataOutput: + schema: + properties: + config: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + config_GetPropertyDistinctFieldOutput: {} + config_GetPropertyDomainTagValuePairsOutput: {} + config_GetPropertyDomainTagValueTreeOutput: {} + config_GetPropertySplitableExportOutput: {} + config_GetPropertySplitableOutput: {} + config_GetPropertyTagValuePairsOutput: {} + config_GetPropertyTagValueTreeOutput: {} + config_ListItemFilterOutput: + schema: + properties: + configs: + items: + $ref: '#/definitions/ConfigDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + config_PerformChangeOwnerOutput: {} + config_PerformClassMetadataOutput: {} + config_PerformPurgeSplitableOutput: {} + config_PerformSetClassMetadataOutput: {} + config_PerformSetUserMetadataOutput: {} + config_PerformValidateOutput: + schema: + properties: + config: + $ref: '#/definitions/ConfigValidateOutput' + type: object + config_ValidateCreateDataOutput: + schema: + properties: + config: + $ref: '#/definitions/ConfigDetails' + type: object + config_ValidateUpdateDataOutput: + schema: + properties: + config: + $ref: '#/definitions/ConfigDetails' + type: object + email_queue_CustomizeDeleteOutput: + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueDetails' + type: object + email_queue_FetchCustomizeColumnsOutput: + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueDetails' + type: object + email_queue_GetPropertyDistinctFieldOutput: {} + email_queue_GetPropertySplitableExportOutput: {} + email_queue_GetPropertySplitableOutput: {} + email_queue_ListItemFilterOutput: + schema: + properties: + email_queues: + items: + $ref: '#/definitions/EmailQueueDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + email_queue_PerformPurgeSplitableOutput: {} + email_queue_PerformSendOutput: {} + email_queue_ValidateCreateDataOutput: + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueDetails' + type: object + email_queue_ValidateUpdateDataOutput: + schema: + properties: + email_queue: + $ref: '#/definitions/EmailQueueDetails' + type: object + email_queue_status_CustomizeDeleteOutput: + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseDetails' + type: object + email_queue_status_FetchCustomizeColumnsOutput: + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseDetails' + type: object + email_queue_status_GetPropertyDistinctFieldOutput: {} + email_queue_status_GetPropertySplitableExportOutput: {} + email_queue_status_GetPropertySplitableOutput: {} + email_queue_status_ListItemFilterOutput: + schema: + properties: + email_queue_statuses: + items: + $ref: '#/definitions/ModelBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + email_queue_status_PerformPurgeSplitableOutput: {} + email_queue_status_ValidateCreateDataOutput: + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseDetails' + type: object + email_queue_status_ValidateUpdateDataOutput: + schema: + properties: + email_queue_status: + $ref: '#/definitions/ModelBaseDetails' + type: object + event_CustomizeDeleteOutput: + schema: + properties: + event: + $ref: '#/definitions/ModelBaseDetails' + type: object + event_FetchCustomizeColumnsOutput: + schema: + properties: + event: + $ref: '#/definitions/ModelBaseDetails' + type: object + event_GetPropertyDistinctFieldOutput: {} + event_GetPropertySplitableExportOutput: {} + event_GetPropertySplitableOutput: {} + event_ListItemFilterOutput: + schema: + properties: + events: + items: + $ref: '#/definitions/ModelBaseDetails' + type: array + x-go-name: Output + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + event_PerformPurgeSplitableOutput: {} + event_ValidateCreateDataOutput: + schema: + properties: + event: + $ref: '#/definitions/ModelBaseDetails' + type: object + event_ValidateUpdateDataOutput: + schema: + properties: + event: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_CustomizeDeleteOutput: + schema: + properties: + notification: + $ref: '#/definitions/NotificationDetails' + type: object + notification_FetchCustomizeColumnsOutput: + schema: + properties: + notification: + $ref: '#/definitions/NotificationDetails' + type: object + notification_GetDetailsClassMetadataOutput: + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + notification_GetDetailsMetadataOutput: + schema: + properties: + notification: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + notification_GetDetailsStatusOutput: + schema: + properties: + notification: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + notification_GetPropertyDistinctFieldOutput: {} + notification_GetPropertySplitableExportOutput: {} + notification_GetPropertySplitableOutput: {} + notification_GetPropertyStatisticsOutput: + schema: + properties: + notification: + $ref: '#/definitions/StatusStatistic' + type: object + notification_GetPropertyTagValuePairsOutput: {} + notification_GetPropertyTagValueTreeOutput: {} + notification_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + notifications: + items: + $ref: '#/definitions/NotificationDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + notification_PerformClassMetadataOutput: {} + notification_PerformEventNotifyOutput: + schema: + properties: + notification: + $ref: '#/definitions/NotificationManagerEventNotifyOutput' + type: object + notification_PerformPurgeSplitableOutput: {} + notification_PerformSetClassMetadataOutput: {} + notification_PerformSetUserMetadataOutput: {} + notification_PerformStatusOutput: {} + notification_ValidateCreateDataOutput: + schema: + properties: + notification: + $ref: '#/definitions/NotificationDetails' + type: object + notification_ValidateUpdateDataOutput: + schema: + properties: + notification: + $ref: '#/definitions/NotificationDetails' + type: object + notification_log_CustomizeDeleteOutput: + schema: + properties: + notification_log: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_log_FetchCustomizeColumnsOutput: + schema: + properties: + notification_log: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_log_GetPropertyDistinctFieldOutput: {} + notification_log_GetPropertySplitableExportOutput: {} + notification_log_GetPropertySplitableOutput: {} + notification_log_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + notification_logs: + items: + $ref: '#/definitions/ModelBaseDetails' + type: array + x-go-name: Output + offset: + format: int64 + type: integer + x-go-name: Offset + total: + format: int64 + type: integer + x-go-name: Total + type: object + notification_log_PerformPurgeSplitableOutput: {} + notification_log_ValidateCreateDataOutput: + schema: + properties: + notification_log: + $ref: '#/definitions/ModelBaseDetails' + type: object + notification_log_ValidateUpdateDataOutput: + schema: + properties: + notification_log: + $ref: '#/definitions/ModelBaseDetails' + type: object + receiver_CustomizeDeleteOutput: + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverDetails' + type: object + receiver_FetchCustomizeColumnsOutput: + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverDetails' + type: object + receiver_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + receiver: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + receiver_GetDetailsClassMetadataOutput: + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + receiver_GetDetailsMetadataOutput: + schema: + properties: + receiver: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + receiver_GetDetailsStatusOutput: + schema: + properties: + receiver: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + receiver_GetPropertyDistinctFieldOutput: {} + receiver_GetPropertyDomainTagValuePairsOutput: {} + receiver_GetPropertyDomainTagValueTreeOutput: {} + receiver_GetPropertySplitableExportOutput: {} + receiver_GetPropertySplitableOutput: {} + receiver_GetPropertyTagValuePairsOutput: {} + receiver_GetPropertyTagValueTreeOutput: {} + receiver_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + receivers: + items: + $ref: '#/definitions/ReceiverDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + receiver_PerformChangeOwnerOutput: {} + receiver_PerformClassMetadataOutput: {} + receiver_PerformDisableOutput: {} + receiver_PerformEnableContactTypeOutput: {} + receiver_PerformEnableOutput: {} + receiver_PerformGetSubscriptionOutput: {} + receiver_PerformGetTypesOutput: + schema: + properties: + receiver: + $ref: '#/definitions/ConfigManagerGetTypesOutput' + type: object + receiver_PerformIntellijGetOutput: {} + receiver_PerformPurgeSplitableOutput: {} + receiver_PerformSetClassMetadataOutput: {} + receiver_PerformSetUserMetadataOutput: {} + receiver_PerformStatusOutput: {} + receiver_PerformTriggerVerifyOutput: {} + receiver_PerformVerifyOutput: {} + receiver_ValidateCreateDataOutput: + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverDetails' + type: object + receiver_ValidateUpdateDataOutput: + schema: + properties: + receiver: + $ref: '#/definitions/ReceiverDetails' + type: object + robot_CustomizeDeleteOutput: + schema: + properties: + robot: + $ref: '#/definitions/RobotDetails' + type: object + robot_FetchCustomizeColumnsOutput: + schema: + properties: + robot: + $ref: '#/definitions/RobotDetails' + type: object + robot_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + robot: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + robot_GetDetailsClassMetadataOutput: + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + robot_GetDetailsMetadataOutput: + schema: + properties: + robot: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + robot_GetDetailsStatusOutput: + schema: + properties: + robot: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + robot_GetPropertyDistinctFieldOutput: {} + robot_GetPropertyDomainStatisticsOutput: + schema: + properties: + robot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + robot_GetPropertyProjectStatisticsOutput: + schema: + properties: + robot: + items: + $ref: '#/definitions/ProjectStatistic' + type: array + x-go-name: Output + type: object + robot_GetPropertyProjectTagValuePairsOutput: {} + robot_GetPropertyProjectTagValueTreeOutput: {} + robot_GetPropertySplitableExportOutput: {} + robot_GetPropertySplitableOutput: {} + robot_GetPropertyStatisticsOutput: + schema: + properties: + robot: + $ref: '#/definitions/StatusStatistic' + type: object + robot_GetPropertyTagValuePairsOutput: {} + robot_GetPropertyTagValueTreeOutput: {} + robot_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + robots: + items: + $ref: '#/definitions/RobotDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + robot_PerformCancelDeleteOutput: {} + robot_PerformChangeOwnerOutput: {} + robot_PerformClassMetadataOutput: {} + robot_PerformDisableOutput: {} + robot_PerformEnableOutput: {} + robot_PerformFreezeOutput: {} + robot_PerformPrivateOutput: {} + robot_PerformPublicOutput: {} + robot_PerformPurgeSplitableOutput: {} + robot_PerformSetClassMetadataOutput: {} + robot_PerformSetUserMetadataOutput: {} + robot_PerformStatusOutput: {} + robot_PerformUnfreezeOutput: {} + robot_ValidateCreateDataOutput: + schema: + properties: + robot: + $ref: '#/definitions/RobotDetails' + type: object + robot_ValidateUpdateDataOutput: + schema: + properties: + robot: + $ref: '#/definitions/RobotDetails' + type: object + subscriber_CustomizeDeleteOutput: + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberDetails' + type: object + subscriber_FetchCustomizeColumnsOutput: + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberDetails' + type: object + subscriber_GetDetailsClassMetadataOutput: + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + subscriber_GetDetailsMetadataOutput: + schema: + properties: + subscriber: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + subscriber_GetPropertyDistinctFieldOutput: {} + subscriber_GetPropertySplitableExportOutput: {} + subscriber_GetPropertySplitableOutput: {} + subscriber_GetPropertyTagValuePairsOutput: {} + subscriber_GetPropertyTagValueTreeOutput: {} + subscriber_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + subscribers: + items: + $ref: '#/definitions/SubscriberDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + subscriber_PerformChangeOutput: {} + subscriber_PerformClassMetadataOutput: {} + subscriber_PerformDisableOutput: {} + subscriber_PerformEnableOutput: {} + subscriber_PerformPurgeSplitableOutput: {} + subscriber_PerformSetClassMetadataOutput: {} + subscriber_PerformSetReceiverOutput: {} + subscriber_PerformSetUserMetadataOutput: {} + subscriber_ValidateCreateDataOutput: + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberDetails' + type: object + subscriber_ValidateUpdateDataOutput: + schema: + properties: + subscriber: + $ref: '#/definitions/SubscriberDetails' + type: object + subscriber_receiver_CustomizeDeleteOutput: + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + subscriber_receiver_FetchCustomizeColumnsOutput: + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + subscriber_receiver_GetPropertyDistinctFieldOutput: {} + subscriber_receiver_GetPropertySplitableExportOutput: {} + subscriber_receiver_GetPropertySplitableOutput: {} + subscriber_receiver_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + subscriber_receivers: + items: + $ref: '#/definitions/JointResourceBaseDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + subscriber_receiver_PerformPurgeSplitableOutput: {} + subscriber_receiver_ValidateCreateDataOutput: + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + subscriber_receiver_ValidateUpdateDataOutput: + schema: + properties: + subscriber_receiver: + $ref: '#/definitions/JointResourceBaseDetails' + type: object + template_CustomizeDeleteOutput: + schema: + properties: + template: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + template_FetchCustomizeColumnsOutput: + schema: + properties: + template: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + template_GetDetailsClassMetadataOutput: + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + template_GetDetailsMetadataOutput: + schema: + properties: + template: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + template_GetPropertyDistinctFieldOutput: {} + template_GetPropertySplitableExportOutput: {} + template_GetPropertySplitableOutput: {} + template_GetPropertyTagValuePairsOutput: {} + template_GetPropertyTagValueTreeOutput: {} + template_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + templates: + items: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + template_PerformClassMetadataOutput: {} + template_PerformPurgeSplitableOutput: {} + template_PerformSaveOutput: {} + template_PerformSetClassMetadataOutput: {} + template_PerformSetUserMetadataOutput: {} + template_ValidateCreateDataOutput: + schema: + properties: + template: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + template_ValidateUpdateDataOutput: + schema: + properties: + template: + $ref: '#/definitions/StandaloneAnonResourceDetails' + type: object + topic_CustomizeDeleteOutput: + schema: + properties: + topic: + $ref: '#/definitions/TopicDetails' + type: object + topic_FetchCustomizeColumnsOutput: + schema: + properties: + topic: + $ref: '#/definitions/TopicDetails' + type: object + topic_GetDetailsClassMetadataOutput: + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + topic_GetDetailsMetadataOutput: + schema: + properties: + topic: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + topic_GetDetailsStatusOutput: + schema: + properties: + topic: + $ref: '#/definitions/GetDetailsStatusOutput' + type: object + topic_GetPropertyDistinctFieldOutput: {} + topic_GetPropertySplitableExportOutput: {} + topic_GetPropertySplitableOutput: {} + topic_GetPropertyStatisticsOutput: + schema: + properties: + topic: + $ref: '#/definitions/StatusStatistic' + type: object + topic_GetPropertyTagValuePairsOutput: {} + topic_GetPropertyTagValueTreeOutput: {} + topic_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + topics: + items: + $ref: '#/definitions/TopicDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + topic_PerformClassMetadataOutput: {} + topic_PerformDisableOutput: {} + topic_PerformEnableOutput: {} + topic_PerformPurgeSplitableOutput: {} + topic_PerformSetClassMetadataOutput: {} + topic_PerformSetUserMetadataOutput: {} + topic_PerformStatusOutput: {} + topic_ValidateCreateDataOutput: + schema: + properties: + topic: + $ref: '#/definitions/TopicDetails' + type: object + topic_ValidateUpdateDataOutput: + schema: + properties: + topic: + $ref: '#/definitions/TopicDetails' + type: object +schemes: +- https +- http +securityDefinitions: + keystone: + in: header + name: X-Auth-Token + type: apiKey +swagger: "2.0" diff --git a/docs/swagger/swagger_yunionconf.yaml b/docs/swagger/swagger_yunionconf.yaml new file mode 100644 index 0000000000..9b4fe209c2 --- /dev/null +++ b/docs/swagger/swagger_yunionconf.yaml @@ -0,0 +1,1848 @@ +basePath: / +consumes: +- application/json +definitions: + ChangeOwnerCandidateDomainsOutput: + properties: + candidates: + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: Candidates + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + Error: + properties: + class: + type: string + x-go-name: Class + code: + format: int64 + type: integer + x-go-name: Code + details: + type: string + x-go-name: Details + type: object + x-go-package: yunion.io/x/onecloud/pkg/httperrors + PerformChangeDomainOwnerInput: + properties: + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPrivateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PerformPublicDomainInput: + properties: + scope: + description: 共享项目资源的共享范围，可能的值为：project, domain和system + pattern: project|domain|system + type: string + x-go-name: Scope + shared_domain_ids: + description: 如果共享范围为域，则在此列表中指定共享的目标域 + items: + type: string + type: array + x-go-name: SharedDomainIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + PurgeSplitTableInput: + properties: + tables: + items: + type: string + type: array + x-go-name: Tables + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseCreateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + delete_fail_reason: + $ref: '#/definitions/Error' + update_fail_reason: + $ref: '#/definitions/Error' + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + ResourceBaseUpdateInput: + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + STag: + properties: + key: + description: 标签Kye + type: string + x-go-name: Key + value: + description: 标签Value + type: string + x-go-name: Value + type: object + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + ScopedPolicyBindInput: + properties: + scope: + $ref: '#/definitions/TRbacScope' + target_ids: + description: 绑定的目标ID（域或者项目ID) + items: + type: string + type: array + x-go-name: TargetIds + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf + ScopedPolicyBindingDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + category: + type: string + x-go-name: Category + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + policy: + type: object + x-go-name: Policies + policy_id: + type: string + x-go-name: PolicyId + policy_name: + type: string + x-go-name: PolicyName + priority: + format: int64 + type: integer + x-go-name: Priority + project: + type: string + x-go-name: Project + project_domain: + type: string + x-go-name: ProjectDomain + project_id: + type: string + x-go-name: ProjectId + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf + ScopedPolicyCreateInput: + properties: + __meta__: + additionalProperties: + type: string + description: 标签列表,最多支持20个 + example: + user:rd: op + type: object + x-go-name: Metadata + category: + description: 策略类别 + type: string + x-go-name: Category + description: + description: 资源描述 + example: test create network + type: string + x-go-name: Description + dry_run: + default: false + description: 预检验参数,若为true则仅检查参数,并不真正创建变更 + type: boolean + x-go-name: DryRun + generate_name: + description: |- + 生成资源名称的模板，如果name为空，则为必填项 + description: generated resource name, given a pattern to generate name, required if name is not given + example: test### + type: string + x-go-name: GenerateName + is_emulated: + description: |- + 资源是否为模拟资源 + description: the resource is an emulated resource + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + name: + description: |- + 资源名称，如果generate_name为空，则为必填项 + description: resource name, required if generated_name is not given + example: test-network + type: string + uniqueItems: true + x-go-name: Name + policies: + description: 策略定义内容 + type: object + x-go-name: Policies + project_domain_id: + description: 指定项目归属域名称或ID + type: string + x-go-name: ProjectDomainId + public_scope: + description: 共享范围 + type: string + x-go-name: PublicScope + required: + - name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf + ScopedPolicyDetails: + properties: + can_delete: + description: 资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因 + example: true + type: boolean + x-go-name: CanDelete + can_update: + description: 资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因 + example: true + type: boolean + x-go-name: CanUpdate + category: + description: 策略类别 + type: string + x-go-name: Category + created_at: + description: 资源创建时间 + format: date-time + type: string + x-go-name: CreatedAt + delete_fail_reason: + $ref: '#/definitions/Error' + deleted: + description: 资源是否被删除 + type: boolean + x-go-name: Deleted + deleted_at: + description: 资源删除时间 + format: date-time + type: string + x-go-name: DeletedAt + description: + description: 资源描述信息 + type: string + x-go-name: Description + domain_id: + description: 域Id + type: string + x-go-name: DomainId + domain_src: + description: '归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: DomainSrc + id: + description: 资源UUID + type: string + x-go-name: Id + is_emulated: + description: |- + 是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机 + list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数 + type: boolean + x-go-name: IsEmulated + is_public: + description: 是否共享 + type: boolean + x-go-name: IsPublic + metadata: + additionalProperties: + type: string + description: 标签 + type: object + x-go-name: Metadata + name: + description: 资源名称 + type: string + x-go-name: Name + policies: + description: 策略内容 + type: object + x-go-name: Policies + project_domain: + description: 资源归属项目的域名称 + type: string + x-go-name: ProjectDomain + public_scope: + description: 默认共享范围 + type: string + x-go-name: PublicScope + public_src: + description: '共享设置的来源, local: 本地设置, cloud: 从云上同步过来' + example: local + type: string + x-go-name: PublicSrc + ref_count: + format: int64 + type: integer + x-go-name: RefCount + shared_domains: + description: 共享的域列表 + items: + $ref: '#/definitions/SharedDomain' + type: array + x-go-name: SharedDomains + shared_projects: + description: 共享的项目列表 + items: + $ref: '#/definitions/SharedProject' + type: array + x-go-name: SharedProjects + update_fail_reason: + $ref: '#/definitions/Error' + update_version: + description: 资源被更新次数 + format: int64 + type: integer + x-go-name: UpdateVersion + updated_at: + description: 资源更新时间 + format: date-time + type: string + x-go-name: UpdatedAt + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf + ScopedPolicyUpdateInput: + properties: + description: + description: 资源描述 + type: string + x-go-name: Description + name: + description: 资源名称 + type: string + x-go-name: Name + policies: + description: 策略定义内容 + type: object + x-go-name: Policies + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis/yunionconf + SharedDomain: + properties: + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + SharedProject: + properties: + domain: + type: string + x-go-name: Domain + domain_id: + type: string + x-go-name: DomainId + id: + type: string + x-go-name: Id + name: + type: string + x-go-name: Name + type: object + x-go-package: yunion.io/x/onecloud/pkg/apis + TRbacScope: + type: string + x-go-package: yunion.io/x/pkg/util/rbacscope + TTagSet: + items: + $ref: '#/definitions/STag' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils + TTagSetList: + items: + $ref: '#/definitions/TTagSet' + type: array + x-go-package: yunion.io/x/onecloud/pkg/util/tagutils +host: '"127.0.0.1:8889"' +info: + contact: + email: lizexi@yunion.cn + name: Zexi Li + description: Yunionconf API + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: "1.0" +paths: + /parameters: + get: + description: 列表 + operationId: parameter_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - in: query + name: namespace_id + type: string + x-go-name: NamespaceId + - description: 服务名称或ID + in: query + name: service_id + type: string + x-go-name: ServiceId + - description: 用户名称或ID + in: query + name: user_id + type: string + x-go-name: UserId + - description: filter by name + in: query + items: + type: string + name: name + type: array + x-go-name: Name + responses: + "200": + $ref: '#/responses/parameter_ListItemFilterOutput' + summary: 配置参数列表 + tags: + - parameter + post: + description: 新建 + operationId: parameter_ValidateCreateData + responses: + "200": + $ref: '#/responses/parameter_ValidateCreateDataOutput' + summary: 新建 + tags: + - parameter + /parameters/{id}: + delete: + description: 删除 + operationId: parameter_CustomizeDelete + parameters: + - description: The Id or Name of parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/parameter_CustomizeDeleteOutput' + summary: 删除 + tags: + - parameter + get: + description: 获取详情 + operationId: parameter_FetchCustomizeColumns + parameters: + - description: The Id or Name of parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/parameter_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - parameter + put: + description: 更新 + operationId: parameter_ValidateUpdateData + parameters: + - description: The Id or Name of parameter + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/parameter_ValidateUpdateDataOutput' + summary: 更新 + tags: + - parameter + /parameters/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: parameter_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/parameter_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - parameter + /parameters/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: parameter_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + parameter: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/parameter_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - parameter + /parameters/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: parameter_GetPropertySplitable + responses: + "200": + $ref: '#/responses/parameter_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - parameter + /parameters/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: parameter_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/parameter_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - parameter + /scopedpolicies: + get: + description: 列表 + operationId: scopedpolicy_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（包含这些标签） + in: query + name: tags + x-go-name: Tags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还包含这些标签，OR的关系） + in: query + name: obj_tags + x-go-name: ObjTags + - $ref: '#/definitions/TTagSet' + description: 通过标签过滤（不包含这些标签） + in: query + name: no_tags + x-go-name: NoTags + - $ref: '#/definitions/TTagSetList' + description: 通过一组标签过滤（还不包含这些标签，AND的关系） + in: query + name: no_obj_tags + x-go-name: NoObjTags + - description: 通过标签排序 + in: query + name: order_by_tag + type: string + x-go-name: OrderByTag + - description: |- + deprecated + 返回资源的标签不包含用户标签 + in: query + name: without_user_meta + type: boolean + x-go-name: WithoutUserMeta + - description: 返回包含用户标签的资源 + in: query + name: with_user_meta + type: boolean + x-go-name: WithUserMeta + - description: 返回包含外部标签的资源 + in: query + name: with_cloud_meta + type: boolean + x-go-name: WithCloudMeta + - description: 返回包含任意标签的资源 + in: query + name: with_any_meta + type: boolean + x-go-name: WithAnyMeta + - description: 返回列表数据中包含资源的标签数据（Metadata） + in: query + name: with_meta + type: boolean + x-go-name: WithMeta + - description: 显示所有的资源，包括模拟的资源 + in: query + name: show_emulated + type: boolean + x-go-name: ShowEmulated + - description: 以资源ID过滤列表 + in: query + items: + type: string + name: id + type: array + x-go-name: Ids + - description: 以资源名称过滤列表 + in: query + items: + type: string + name: name + type: array + x-go-name: Names + - description: 指定查询的权限范围，可能值为project, domain or system + in: query + name: scope + type: string + x-go-name: Scope + - description: 指定项目归属域名称或ID + in: query + name: project_domain_id + type: string + x-go-name: ProjectDomainId + - description: 对具有域属性的资源，严格匹配域ID + in: query + items: + type: string + name: project_domain_ids + type: array + x-go-name: ProjectDomainIds + - description: 按domain名称排序，可能值为asc|desc + in: query + name: order_by_domain + pattern: asc|desc + type: string + x-go-name: OrderByDomain + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: domain_tags + x-go-name: DomainTags + - $ref: '#/definitions/TTagSetList' + description: filter by domain tags + in: query + name: no_domain_tags + x-go-name: NoDomainTags + - description: 以资源是否共享过滤列表 + in: query + name: is_public + type: boolean + x-go-name: IsPublic + - description: 根据资源的共享范围过滤列表，可能值为：system, domain, project + in: query + name: public_scope + type: string + x-go-name: PublicScope + - description: 策略类别 + in: query + items: + type: string + name: category + type: array + x-go-name: Category + responses: + "200": + $ref: '#/responses/scopedpolicy_ListItemFilterOutput' + summary: 范围策略列表 + tags: + - scopedpolicy + post: + description: 新建 + operationId: scopedpolicy_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scopedpolicy: + $ref: '#/definitions/ScopedPolicyCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_ValidateCreateDataOutput' + summary: 新建 + tags: + - scopedpolicy + /scopedpolicies/{id}: + delete: + description: 删除 + operationId: scopedpolicy_CustomizeDelete + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_CustomizeDeleteOutput' + summary: 删除 + tags: + - scopedpolicy + get: + description: 获取详情 + operationId: scopedpolicy_FetchCustomizeColumns + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scopedpolicy + put: + description: 更新 + operationId: scopedpolicy_ValidateUpdateData + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scopedpolicy + /scopedpolicies/{id}/bind: + post: + description: 执行操作Bind + operationId: scopedpolicy_PerformBind + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyBindInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformBindOutput' + summary: 执行操作Bind + tags: + - scopedpolicy + /scopedpolicies/{id}/change-owner: + post: + description: 执行操作ChangeOwner + operationId: scopedpolicy_PerformChangeOwner + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/PerformChangeDomainOwnerInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformChangeOwnerOutput' + summary: 执行操作ChangeOwner + tags: + - scopedpolicy + /scopedpolicies/{id}/change-owner-candidate-domains: + get: + description: 获取指定信息ChangeOwnerCandidateDomains + operationId: scopedpolicy_GetDetailsChangeOwnerCandidateDomains + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_GetDetailsChangeOwnerCandidateDomainsOutput' + summary: 获取指定信息ChangeOwnerCandidateDomains + tags: + - scopedpolicy + /scopedpolicies/{id}/class-metadata: + get: + description: 获取指定信息ClassMetadata + operationId: scopedpolicy_GetDetailsClassMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_GetDetailsClassMetadataOutput' + summary: 获取指定信息ClassMetadata + tags: + - scopedpolicy + post: + description: 执行操作ClassMetadata + operationId: scopedpolicy_PerformClassMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformClassMetadataOutput' + summary: 更新资源的 class 标签 + tags: + - scopedpolicy + /scopedpolicies/{id}/metadata: + get: + description: 获取指定信息Metadata + operationId: scopedpolicy_GetDetailsMetadata + parameters: + - description: |- + 指定需要获取的所有标签的KEY列表，如果列表为空，则获取全部标签 + 标签分为 + + 类型 | 说明 | + ----------|---------------------------------------------| + 系统标签 | 平台定义的标签 | + 用户标签 | key以user:为前缀，用户自定义标签 | + 外部标签 | key以ext:为前缀，为从其他平台同步过来的标签 | + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 按标签前缀过滤 + in: query + name: prefix + type: string + x-go-name: Prefix + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicy_GetDetailsMetadataOutput' + summary: 获取资源标签（元数据） + tags: + - scopedpolicy + /scopedpolicies/{id}/private: + post: + description: 执行操作Private + operationId: scopedpolicy_PerformPrivate + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/PerformPrivateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformPrivateOutput' + summary: 执行操作Private + tags: + - scopedpolicy + /scopedpolicies/{id}/public: + post: + description: 执行操作Public + operationId: scopedpolicy_PerformPublic + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/PerformPublicDomainInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformPublicOutput' + summary: 执行操作Public + tags: + - scopedpolicy + /scopedpolicies/{id}/set-class-metadata: + post: + description: 执行操作SetClassMetadata + operationId: scopedpolicy_PerformSetClassMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformSetClassMetadataOutput' + summary: 全量替换资源的所有 class 标签 + tags: + - scopedpolicy + /scopedpolicies/{id}/set-user-metadata: + post: + description: 执行操作SetUserMetadata + operationId: scopedpolicy_PerformSetUserMetadata + parameters: + - description: The Id or Name of scopedpolicy + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Input + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformSetUserMetadataOutput' + summary: 全量替换资源的所有用户标签 + tags: + - scopedpolicy + /scopedpolicies/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scopedpolicy_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scopedpolicy + /scopedpolicies/domain-tag-value-pairs: + get: + description: 获取指定资源类的信息DomainTagValuePairs + operationId: scopedpolicy_GetPropertyDomainTagValuePairs + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyDomainTagValuePairsOutput' + summary: 获取指定资源类的信息DomainTagValuePairs + tags: + - scopedpolicy + /scopedpolicies/domain-tag-value-tree: + get: + description: 获取指定资源类的信息DomainTagValueTree + operationId: scopedpolicy_GetPropertyDomainTagValueTree + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyDomainTagValueTreeOutput' + summary: 获取指定资源类的信息DomainTagValueTree + tags: + - scopedpolicy + /scopedpolicies/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scopedpolicy_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scopedpolicy: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicy_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scopedpolicy + /scopedpolicies/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scopedpolicy_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scopedpolicy + /scopedpolicies/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scopedpolicy_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scopedpolicy + /scopedpolicies/tag-value-pairs: + get: + description: 获取指定资源类的信息TagValuePairs + operationId: scopedpolicy_GetPropertyTagValuePairs + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyTagValuePairsOutput' + summary: 获取指定资源类的信息TagValuePairs + tags: + - scopedpolicy + /scopedpolicies/tag-value-tree: + get: + description: 获取指定资源类的信息TagValueTree + operationId: scopedpolicy_GetPropertyTagValueTree + responses: + "200": + $ref: '#/responses/scopedpolicy_GetPropertyTagValueTreeOutput' + summary: 获取指定资源类的信息TagValueTree + tags: + - scopedpolicy + /scopedpolicybindings: + get: + description: 列表 + operationId: scopedpolicybinding_ListItemFilter + parameters: + - default: 20 + description: 查询限制量 + format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + - default: 0 + description: 查询偏移量 + format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - description: 列表排序时，用于排序的字段的名称，该字段不提供时，则按默认字段排序。一般时按照资源的新建时间逆序排序。 + in: query + items: + type: string + name: order_by + type: array + x-go-name: OrderBy + - description: 列表排序时的顺序，desc为从高到低，asc为从低到高。默认是按照资源的创建时间desc排序。 + example: desc|asc + in: query + name: order + type: string + x-go-name: Order + - description: 列表返回资源的更多详细信息。默认只显示基本字段，该字段为true则返回扩展字段信息。 + in: query + name: details + type: boolean + x-go-name: Details + - description: 模糊搜索所有字段 + in: query + name: search + type: string + x-go-name: Search + - description: |- + 指定过滤条件，允许指定多个，每个条件的格式为"字段名称.操作符(匹配信息)"，例如name字段等于test的过滤器为：name.equals('test') + 支持的操作符如下： + + 操作符 | 参数个数 | 举例 | 说明 | + ---------------|----------|------------------------------------------------|-----------------------------| + in | > 0 | name.in("test", "good") | 在给定数组中 | + notin | > 0 | name.notin('test') | 不在给定数组中 | + between | 2 | created_at.between('2019-12-10', '2020-01-02') | 在两个值之间 | + ge | 1 | created_at.ge('2020-01-01') | 大于或等于给定值 | + gt | 1 | created_at.gt('2020-01-01') | 严格大于给定值 | + le | 1 | created_at.le('2020-01-01') | 小于或等于给定值 | + lt | 1 | sync_seconds.lt(900) | 严格大于给定值 | + like | > 0 | name.like('%test%') | sql字符串匹配任意一个字符串 | + contains | > 0 | name.contains('test') | 包含任意一个给定字符串 | + startswith | > 0 | name.startswith('test') | 以任意一个给定字符串开头 | + endswith | > 0 | name.endswith('test') | 以任意一个给定字符串结尾 | + equals | > 0 | name.equals('test') | 等于任意一个给定值 | + notequals | 1 | name.notequals('test') | 不等于给定值 | + isnull | 0 | name.isnull() | 值为SQL的NULL | + isnotnull | 0 | name.isnotnull() | 值不为SQL的NULL | + isempty | 0 | name.isempty('test') | 值为空字符串 | + isnotempty | 0 | name.isnotempty('test') | 值不是空字符串 | + isnullorempty | 0 | name.isnullorempty('test') | 值为SQL的NULL或者空字符串 | + in: query + items: + type: string + name: filter + type: array + x-go-name: Filter + - description: |- + 指定关联过滤条件，允许指定多个，后端将根据关联过滤条件和其他表关联查询，支持的查询语法和filter相同， + 和其他表关联的语法如下： + joint_resources.related_key(origin_key).filter_col.filter_ops(values) + 其中，joint_resources为要关联的资源名称，related_key为关联表column，origin_key为当前表column, filter_col为 + 关联表用于查询匹配的field名称，field_ops为filter支持的操作，values为匹配的值 + 举例： + guestnetworks.guest_id(id).ip_addr.equals('10.168.21.222') + in: query + items: + type: string + name: joint_filter + type: array + x-go-name: JointFilter + - description: 如果filter_any为true，则查询所有filter的并集，否则为交集 + in: query + name: filter_any + type: boolean + x-go-name: FilterAny + - description: 返回结果只包含指定的字段 + in: query + items: + type: string + name: field + type: array + x-go-name: Field + - description: 用于数据导出，指定导出的数据字段 + in: query + name: export_keys + type: string + x-go-name: ExportKeys + - description: 返回结果携带delete_fail_reason和update_fail_reason字段 + in: query + name: show_fail_reason + type: boolean + x-go-name: ShowFailReason + - in: query + items: + type: string + name: name + type: array + x-go-name: Name + - in: query + name: policy_id + type: string + x-go-name: PolicyId + - in: query + name: domain_id + type: string + x-go-name: DomainId + - in: query + name: project_id + type: string + x-go-name: ProjectId + - in: query + items: + type: string + name: category + type: array + x-go-name: Category + - in: query + name: effective + type: boolean + x-go-name: Effective + - in: query + name: scope + type: string + x-go-name: Scope + - in: query + name: order_by_scopedpolicy + type: string + x-go-name: OrderByScopedpolicy + responses: + "200": + $ref: '#/responses/scopedpolicybinding_ListItemFilterOutput' + summary: 范围策略列表 + tags: + - scopedpolicybinding + post: + description: 新建 + operationId: scopedpolicybinding_ValidateCreateData + parameters: + - in: body + name: body + schema: + properties: + count: + default: 1 + format: int64 + type: integer + x-go-name: Count + scopedpolicybinding: + $ref: '#/definitions/ResourceBaseCreateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicybinding_ValidateCreateDataOutput' + summary: 新建 + tags: + - scopedpolicybinding + /scopedpolicybindings/{id}: + delete: + description: 删除 + operationId: scopedpolicybinding_CustomizeDelete + parameters: + - description: The Id or Name of scopedpolicybinding + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicybinding_CustomizeDeleteOutput' + summary: 删除 + tags: + - scopedpolicybinding + get: + description: 获取详情 + operationId: scopedpolicybinding_FetchCustomizeColumns + parameters: + - description: The Id or Name of scopedpolicybinding + in: path + name: id + required: true + type: string + x-go-name: Id + responses: + "200": + $ref: '#/responses/scopedpolicybinding_FetchCustomizeColumnsOutput' + summary: 获取详情 + tags: + - scopedpolicybinding + put: + description: 更新 + operationId: scopedpolicybinding_ValidateUpdateData + parameters: + - description: The Id or Name of scopedpolicybinding + in: path + name: id + required: true + type: string + x-go-name: Id + - in: body + name: body + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ResourceBaseUpdateInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicybinding_ValidateUpdateDataOutput' + summary: 更新 + tags: + - scopedpolicybinding + /scopedpolicybindings/distinct-field: + get: + description: 获取指定资源类的信息DistinctField + operationId: scopedpolicybinding_GetPropertyDistinctField + responses: + "200": + $ref: '#/responses/scopedpolicybinding_GetPropertyDistinctFieldOutput' + summary: 获取指定资源类的信息DistinctField + tags: + - scopedpolicybinding + /scopedpolicybindings/purge-splitable: + post: + description: 执行操作PurgeSplitable + operationId: scopedpolicybinding_PerformPurgeSplitable + parameters: + - in: body + name: body + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/PurgeSplitTableInput' + type: object + x-go-name: Body + responses: + "200": + $ref: '#/responses/scopedpolicybinding_PerformPurgeSplitableOutput' + summary: 执行操作PurgeSplitable + tags: + - scopedpolicybinding + /scopedpolicybindings/splitable: + get: + description: 获取指定资源类的信息Splitable + operationId: scopedpolicybinding_GetPropertySplitable + responses: + "200": + $ref: '#/responses/scopedpolicybinding_GetPropertySplitableOutput' + summary: 获取指定资源类的信息Splitable + tags: + - scopedpolicybinding + /scopedpolicybindings/splitable-export: + get: + description: 获取指定资源类的信息SplitableExport + operationId: scopedpolicybinding_GetPropertySplitableExport + parameters: + - in: query + name: table + type: string + x-go-name: Table + - format: int64 + in: query + name: offset + type: integer + x-go-name: Offset + - format: int64 + in: query + name: limit + type: integer + x-go-name: Limit + responses: + "200": + $ref: '#/responses/scopedpolicybinding_GetPropertySplitableExportOutput' + summary: 获取指定资源类的信息SplitableExport + tags: + - scopedpolicybinding +produces: +- application/json +responses: + parameter_CustomizeDeleteOutput: + schema: + properties: + parameter: + $ref: '#/definitions/ResourceBaseDetails' + type: object + parameter_FetchCustomizeColumnsOutput: + schema: + properties: + parameter: + $ref: '#/definitions/ResourceBaseDetails' + type: object + parameter_GetPropertyDistinctFieldOutput: {} + parameter_GetPropertySplitableExportOutput: {} + parameter_GetPropertySplitableOutput: {} + parameter_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + parameters: + items: + $ref: '#/definitions/ResourceBaseDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + parameter_PerformPurgeSplitableOutput: {} + parameter_ValidateCreateDataOutput: + schema: + properties: + parameter: + $ref: '#/definitions/ResourceBaseDetails' + type: object + parameter_ValidateUpdateDataOutput: + schema: + properties: + parameter: + $ref: '#/definitions/ResourceBaseDetails' + type: object + scopedpolicy_CustomizeDeleteOutput: + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyDetails' + type: object + scopedpolicy_FetchCustomizeColumnsOutput: + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyDetails' + type: object + scopedpolicy_GetDetailsChangeOwnerCandidateDomainsOutput: + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ChangeOwnerCandidateDomainsOutput' + type: object + scopedpolicy_GetDetailsClassMetadataOutput: + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scopedpolicy_GetDetailsMetadataOutput: + schema: + properties: + scopedpolicy: + additionalProperties: + type: string + type: object + x-go-name: Output + type: object + scopedpolicy_GetPropertyDistinctFieldOutput: {} + scopedpolicy_GetPropertyDomainTagValuePairsOutput: {} + scopedpolicy_GetPropertyDomainTagValueTreeOutput: {} + scopedpolicy_GetPropertySplitableExportOutput: {} + scopedpolicy_GetPropertySplitableOutput: {} + scopedpolicy_GetPropertyTagValuePairsOutput: {} + scopedpolicy_GetPropertyTagValueTreeOutput: {} + scopedpolicy_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scopedpolicies: + items: + $ref: '#/definitions/ScopedPolicyDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scopedpolicy_PerformBindOutput: {} + scopedpolicy_PerformChangeOwnerOutput: {} + scopedpolicy_PerformClassMetadataOutput: {} + scopedpolicy_PerformPrivateOutput: {} + scopedpolicy_PerformPublicOutput: {} + scopedpolicy_PerformPurgeSplitableOutput: {} + scopedpolicy_PerformSetClassMetadataOutput: {} + scopedpolicy_PerformSetUserMetadataOutput: {} + scopedpolicy_ValidateCreateDataOutput: + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyDetails' + type: object + scopedpolicy_ValidateUpdateDataOutput: + schema: + properties: + scopedpolicy: + $ref: '#/definitions/ScopedPolicyDetails' + type: object + scopedpolicybinding_CustomizeDeleteOutput: + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: object + scopedpolicybinding_FetchCustomizeColumnsOutput: + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: object + scopedpolicybinding_GetPropertyDistinctFieldOutput: {} + scopedpolicybinding_GetPropertySplitableExportOutput: {} + scopedpolicybinding_GetPropertySplitableOutput: {} + scopedpolicybinding_ListItemFilterOutput: + schema: + properties: + limit: + format: int64 + type: integer + x-go-name: Limit + offset: + format: int64 + type: integer + x-go-name: Offset + scopedpolicybindings: + items: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: array + x-go-name: Output + total: + format: int64 + type: integer + x-go-name: Total + type: object + scopedpolicybinding_PerformPurgeSplitableOutput: {} + scopedpolicybinding_ValidateCreateDataOutput: + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: object + scopedpolicybinding_ValidateUpdateDataOutput: + schema: + properties: + scopedpolicybinding: + $ref: '#/definitions/ScopedPolicyBindingDetails' + type: object +schemes: +- https +- http +securityDefinitions: + keystone: + in: header + name: X-Auth-Token + type: apiKey +swagger: "2.0" diff --git a/pkg/apis/compute/zz_generated.model.go b/pkg/apis/compute/zz_generated.model.go index 0e6409c9fa..97ee980141 100644 --- a/pkg/apis/compute/zz_generated.model.go +++ b/pkg/apis/compute/zz_generated.model.go @@ -154,7 +154,8 @@ type SBucket struct { // SCDNDomain is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SCDNDomain. type SCDNDomain struct { - apis.SEnabledStatusInfrasResourceBase + apis.SVirtualResourceBase + apis.SEnabledResourceBase apis.SExternalizedResourceBase SDeletePreventableResourceBase SManagedResourceBase @@ -165,6 +166,20 @@ type SCDNDomain struct { ServiceType string `json:"service_type"` // 加速区域 Area string `json:"area"` + // 是否忽略参数 + CacheKeys *cloudprovider.SCDNCacheKeys `json:"cache_keys"` + // 是否分片回源 + RangeOriginPull *cloudprovider.SCDNRangeOriginPull `json:"range_origin_pull"` + // 缓存配置 + Cache *cloudprovider.SCDNCache `json:"cache"` + // https配置 + HTTPS *cloudprovider.SCDNHttps `json:"https"` + // 强制跳转 + ForceRedirect *cloudprovider.SCDNForceRedirect `json:"force_redirect"` + // 防盗链配置 + Referer *cloudprovider.SCDNReferer `json:"referer"` + // 浏览器缓存配置 + MaxAge *cloudprovider.SCDNMaxAge `json:"max_age"` } // SCachedLoadbalancerAcl is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SCachedLoadbalancerAcl. @@ -1081,6 +1096,9 @@ type SGuest struct { // 关机操作类型 // example: stop ShutdownBehavior string `json:"shutdown_behavior"` + // 关机收费模式 + // example: keep_charging, stop_charging + ShutdownMode string `json:"shutdown_mode"` // 秘钥对Id KeypairId string `json:"keypair_id"` // 备份机所在宿主机Id @@ -1341,6 +1359,7 @@ type SHoststorage struct { // 存储Id StorageId string `json:"storage_id"` // 挂载点 + // nvme pci address MountPoint string `json:"mount_point"` // 是否是根分区 IsRootPartition bool `json:"is_root_partition"` @@ -1491,6 +1510,12 @@ type SIsolatedDevice struct { NetworkIndex byte `json:"network_index"` // Nic wire id WireId string `json:"wire_id"` + // Offload interface name + OvsOffloadInterface string `json:"ovs_offload_interface"` + // NVME disk size + NvmeSizeMB int `json:"nvme_size_mb"` + // guest disk index + DiskIndex byte `json:"disk_index"` // # pci address of `Bus:Device.Function` format, or usb bus address of `bus.addr` Addr string `json:"addr"` VendorDeviceId string `json:"vendor_device_id"` @@ -1502,6 +1527,16 @@ type SIsolatedDevice struct { ReservedStorage int `json:"reserved_storage"` } +// SIsolatedDeviceModel is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SIsolatedDeviceModel. +type SIsolatedDeviceModel struct { + apis.SStandaloneAnonResourceBase + Model string `json:"model"` + VendorId string `json:"vendor_id"` + DeviceId string `json:"device_id"` + DevType string `json:"dev_type"` + HotPluggable *bool `json:"hot_pluggable,omitempty"` +} + // SKafka is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SKafka. type SKafka struct { apis.SVirtualResourceBase @@ -1556,9 +1591,12 @@ type SKubeCluster struct { apis.SEnabledStatusInfrasResourceBase apis.SExternalizedResourceBase SManagedResourceBase + SVpcResourceBase SCloudregionResourceBase + Version string `json:"version"` // 本地KubeserverId - ExternalClusterId string `json:"external_cluster_id"` + ExternalClusterId string `json:"external_cluster_id"` + NetworkIds *SKubeNetworkIds `json:"network_ids"` } // SKubeNode is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SKubeNode. @@ -1573,7 +1611,13 @@ type SKubeNode struct { type SKubeNodePool struct { apis.SStatusStandaloneResourceBase apis.SExternalizedResourceBase - CloudKubeClusterId string `json:"cloud_kube_cluster_id"` + NetworkIds *SKubeNetworkIds `json:"network_ids"` + InstanceTypes *SInstanceTypes `json:"instance_types"` + MinInstanceCount int `json:"min_instance_count"` + MaxInstanceCount int `json:"max_instance_count"` + DesiredInstanceCount int `json:"desired_instance_count"` + RootDiskSizeGb int `json:"root_disk_size_gb"` + CloudKubeClusterId string `json:"cloud_kube_cluster_id"` } // SLoadbalancer is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancer. @@ -1662,12 +1706,9 @@ type SLoadbalancerAgentDeployment struct { // SLoadbalancerAgentParams is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentParams. type SLoadbalancerAgentParams struct { - KeepalivedConfTmpl string `json:"keepalived_conf_tmpl"` - HaproxyConfTmpl string `json:"haproxy_conf_tmpl"` - TelegrafConfTmpl string `json:"telegraf_conf_tmpl"` - Vrrp SLoadbalancerAgentParamsVrrp `json:"vrrp"` - Haproxy SLoadbalancerAgentParamsHaproxy `json:"haproxy"` - Telegraf SLoadbalancerAgentParamsTelegraf `json:"telegraf"` + KeepalivedConfTmpl string `json:"keepalived_conf_tmpl"` + HaproxyConfTmpl string `json:"haproxy_conf_tmpl"` + TelegrafConfTmpl string `json:"telegraf_conf_tmpl"` } // SLoadbalancerAgentParamsHaproxy is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerAgentParamsHaproxy. @@ -2491,7 +2532,6 @@ type SSecurityGroupRule struct { CIDR string `json:"cidr"` Action string `json:"action"` Description string `json:"description"` - IsDirty bool `json:"is_dirty"` } // SServerSku is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SServerSku. @@ -2702,13 +2742,7 @@ type STimer struct { WeekDays byte `json:"week_days"` // 0-31 0 is unlimited MonthDays uint32 `json:"month_days"` - // StartTime represent the start time of this timer - StartTime time.Time `json:"start_time"` - // EndTime represent deadline of this timer - EndTime time.Time `json:"end_time"` - // NextTime represent the time timer should bell - NextTime time.Time `json:"next_time"` - IsExpired bool `json:"is_expired"` + IsExpired bool `json:"is_expired"` } // SVpc is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SVpc. diff --git a/pkg/apis/identity/zz_generated.model.go b/pkg/apis/identity/zz_generated.model.go index f43795de0f..9b50ff2ef8 100644 --- a/pkg/apis/identity/zz_generated.model.go +++ b/pkg/apis/identity/zz_generated.model.go @@ -71,6 +71,7 @@ type SDomain struct { IsDomain *bool `json:"is_domain,omitempty"` DomainId string `json:"domain_id"` ParentId string `json:"parent_id"` + AdminId string `json:"admin_id"` } // SEnabledIdentityBaseResource is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SEnabledIdentityBaseResource. @@ -236,7 +237,8 @@ type SProject struct { // 上级项目或域的ID ParentId string `json:"parent_id"` // 该项目是否为域（domain） - IsDomain *bool `json:"is_domain,omitempty"` + IsDomain *bool `json:"is_domain,omitempty"` + AdminId string `json:"admin_id"` } // SProjectExtended is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SProjectExtended. diff --git a/pkg/apis/notify/zz_generated.model.go b/pkg/apis/notify/zz_generated.model.go index 0676708e42..824ac11959 100644 --- a/pkg/apis/notify/zz_generated.model.go +++ b/pkg/apis/notify/zz_generated.model.go @@ -24,11 +24,10 @@ import ( // SConfig is an autogenerated struct via yunion.io/x/onecloud/pkg/notify/models.SConfig. type SConfig struct { - apis.SStandaloneResourceBase - apis.SDomainizedResourceBase - Type string `json:"type"` - Content jsonutils.JSONObject `json:"content"` - Attribution string `json:"attribution"` + apis.SDomainLevelResourceBase + Type string `json:"type"` + Content *SNotifyConfigContent `json:"content"` + Attribution string `json:"attribution"` } // SEmailQueue is an autogenerated struct via yunion.io/x/onecloud/pkg/notify/models.SEmailQueue. @@ -37,6 +36,8 @@ type SEmailQueue struct { RecvAt time.Time `json:"recv_at"` Dest string `json:"dest"` Subject string `json:"subject"` + DestCc string `json:"dest_cc"` + DestBcc string `json:"dest_bcc"` SessionId string `json:"session_id"` Content jsonutils.JSONObject `json:"content"` ProjectId string `json:"project_id"` @@ -62,11 +63,13 @@ type SEmailQueueStatus struct { type SEvent struct { apis.SLogBase // 资源创建时间 - CreatedAt time.Time `json:"created_at"` - Message string `json:"message"` - Event string `json:"event"` - AdvanceDays int `json:"advance_days"` - TopicId string `json:"topic_id"` + CreatedAt time.Time `json:"created_at"` + Message string `json:"message"` + Event string `json:"event"` + ResourceType string `json:"resource_type"` + Action string `json:"action"` + AdvanceDays int `json:"advance_days"` + TopicId string `json:"topic_id"` } // SNotification is an autogenerated struct via yunion.io/x/onecloud/pkg/notify/models.SNotification. @@ -77,19 +80,35 @@ type SNotification struct { Topic string `json:"topic"` Priority string `json:"priority"` // swagger:ignore - Message string `json:"message"` + Message string `json:"message"` + // swagger:ignore + TopicType string `json:"topic_type"` + // swagger:ignore + TopicId string `json:"topic_id"` + ReceivedAt time.Time `json:"received_at"` + EventId string `json:"event_id"` + SendTimes int `json:"send_times"` +} + +// SNotificationLog is an autogenerated struct via yunion.io/x/onecloud/pkg/notify/models.SNotificationLog. +type SNotificationLog struct { + apis.SLogBase + ContactType string `json:"contact_type"` + // swagger:ignore + Topic string `json:"topic"` + Priority string `json:"priority"` + // swagger:ignore + Message string `json:"message"` + // swagger:ignore + TopicType string `json:"topic_type"` ReceivedAt time.Time `json:"received_at"` EventId string `json:"event_id"` - TopicType string `json:"topic_type"` SendTimes int `json:"send_times"` - Tag string `json:"tag"` } // SReceiver is an autogenerated struct via yunion.io/x/onecloud/pkg/notify/models.SReceiver. type SReceiver struct { - apis.SStatusStandaloneResourceBase - apis.SDomainizedResourceBase - apis.SEnabledResourceBase + apis.SEnabledStatusDomainLevelResourceBase Email string `json:"email"` // swagger:ignore Mobile string `json:"mobile"` @@ -117,7 +136,7 @@ type SRobot struct { type SSubscriber struct { apis.SStandaloneAnonResourceBase apis.SEnabledResourceBase - TopicID string `json:"topic_id"` + TopicId string `json:"topic_id"` Type string `json:"type"` Identification string `json:"identification"` RoleScope string `json:"role_scope"` @@ -162,5 +181,9 @@ type STopic struct { Actions uint32 `json:"actions"` Results *bool `json:"results,omitempty"` AdvanceDays int `json:"advance_days"` + TitleCn string `json:"title_cn"` + TitleEn string `json:"title_en"` + ContentCn string `json:"content_cn"` + ContentEn string `json:"content_en"` WebconsoleDisable *bool `json:"webconsole_disable,omitempty"` } diff --git a/pkg/apis/zz_generated.model.go b/pkg/apis/zz_generated.model.go index b56528359a..9bd798785a 100644 --- a/pkg/apis/zz_generated.model.go +++ b/pkg/apis/zz_generated.model.go @@ -119,7 +119,6 @@ type SExternalizedResourceBase struct { // SI18n is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudcommon/db.SI18n. type SI18n struct { - SStandaloneAnonResourceBase // 资源类型 // example: network ObjType string `json:"obj_type"` @@ -155,6 +154,7 @@ type SKeystoneCacheObject struct { SStandaloneResourceBase DomainId string `json:"domain_id"` Domain string `json:"domain"` + Lang string `json:"lang"` } // SLogBase is an autogenerated struct via yunion.io/x/onecloud/pkg/cloudcommon/db.SLogBase.