add loadblancer acl&cert cached api docs

This commit is contained in:
TangBin
2019-10-12 19:08:17 +08:00
parent 4eeff28661
commit 6351546a79
5 changed files with 112 additions and 46 deletions
+6 -8
View File
@@ -286,14 +286,14 @@ paths:
$ref: "./loadbalancer/loadbalancer.yaml"
/cached_loadbalancer_acls:
$ref: "./loadbalancer/loadbalancercachedacl.yaml"
/cached_loadbalancer_acls/{loadbalancerlistenerId}:
$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"
/cached_loadbalancercertificates/{loadbalancerlistenerId}:
$ref: "./loadbalancer/loadbalancercachedcertificates.yaml"
/loadbalancerlisteners:
$ref: "./loadbalancer/loadbalancerlisteners.yaml"
@@ -337,9 +337,9 @@ paths:
$ref: "./identity/domain.yaml"
/users:
$ref: "./identity/users.yaml"
$ref: "./identity/users.yaml"
/users/{user_id}:
$ref: "./identity/user.yaml"
$ref: "./identity/user.yaml"
/users/{user_id}/join:
$ref: "./identity/user_join.yaml"
/users/{user_id}/leave:
@@ -468,7 +468,6 @@ paths:
/networkinterfaces/{networkinterfaceId}/networks:
$ref: "./networkinterface/networks.yaml"
/buckets:
$ref: "./bucket/buckets.yaml"
/buckets/{bucketName}:
@@ -528,7 +527,6 @@ paths:
/dbinstanceaccounts/{accountId}:
$ref: "./dbinstance/dbinstanceaccount.yaml"
/cloudaccounts:
$ref: "./cloudaccount/cloudaccounts.yaml"
/cloudaccounts/{cloudaccountId}:
+15 -1
View File
@@ -8,4 +8,18 @@ get:
schema:
$ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedAclListResponse"
tags:
- loadbalanceracls
- 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
@@ -18,4 +18,4 @@ delete:
schema:
$ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedCertificateResponse"
tags:
- loadbalancercertificates
- loadbalancercertificates
@@ -8,4 +8,18 @@ get:
schema:
$ref: "../schemas/loadbalancer.yaml#/LoadbalancerCachedCertificateListResponse"
tags:
- loadbalancercertificates
- 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
+75 -35
View File
@@ -89,13 +89,13 @@ LoadbalancerListResponse:
loadbalancers:
type: array
items:
$ref: '#/Loadbalancer'
$ref: "#/Loadbalancer"
LoadbalancerResponse:
type: object
properties:
loadbalancer:
type: object
$ref: '#/Loadbalancer'
$ref: "#/Loadbalancer"
LoadbalancerListenerCreateRequest:
type: object
@@ -137,13 +137,13 @@ LoadbalancerListenerListResponse:
loadbalancerlisteners:
type: array
items:
$ref: '#/LoadbalancerListener'
$ref: "#/LoadbalancerListener"
LoadbalancerListenerResponse:
type: object
properties:
loadbalancerlistener:
type: object
$ref: '#/LoadbalancerListener'
$ref: "#/LoadbalancerListener"
LoadbalancerBackendGroupListResponse:
type: object
@@ -151,13 +151,13 @@ LoadbalancerBackendGroupListResponse:
loadbalancerbackendgroups:
type: array
items:
$ref: '#/LoadbalancerBackendGroup'
$ref: "#/LoadbalancerBackendGroup"
LoadbalancerBackendGroupResponse:
type: object
properties:
loadbalancerbackendgroup:
type: object
$ref: '#/LoadbalancerBackendGroup'
$ref: "#/LoadbalancerBackendGroup"
LoadbalancerBackendCreateRequest:
type: object
@@ -202,13 +202,13 @@ LoadbalancerBackendListResponse:
loadbalancerbackends:
type: array
items:
$ref: '#/LoadbalancerBackend'
$ref: "#/LoadbalancerBackend"
LoadbalancerBackendResponse:
type: object
properties:
loadbalancerbackend:
type: object
$ref: '#/LoadbalancerBackend'
$ref: "#/LoadbalancerBackend"
LoadbalancerAclEntry:
type: object
@@ -221,15 +221,36 @@ LoadbalancerAclEntry:
comment:
type: string
description: 注释
readOnly: true
readOnly: true
LoadbalancerAclEntries:
type: array
items:
$ref: '#/LoadbalancerAclEntry'
$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:
allOf:
- $ref: "./common.yaml#/SharableVirtualResourceBaseResponse"
- $ref: "./common.yaml#/ExternalizedResourceBaseResponse"
- type: object
@@ -238,10 +259,10 @@ LoadbalancerCachedAcl:
type: string
description: 所属的本地访问控制uuid
acl_entries:
$ref: "#/LoadbalancerAclEntries"
$ref: "#/LoadbalancerAclEntries"
LoadbalancerCachedAclResponse:
$ref: "#/LoadbalancerCachedAcl"
$ref: "#/LoadbalancerCachedAcl"
LoadbalancerCachedAclListResponse:
type: object
@@ -251,8 +272,28 @@ LoadbalancerCachedAclListResponse:
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:
allOf:
- $ref: "./common.yaml#/SharableVirtualResourceBaseResponse"
- $ref: "./common.yaml#/ExternalizedResourceBaseResponse"
- type: object
@@ -273,11 +314,11 @@ LoadbalancerCachedCertificateResponse:
publicKey_bitLen:
type: int
description: 公钥长度
readOnly: true
readOnly: true
signature_algorithm:
type: string
description: 签名算法
readOnly: true
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
@@ -287,22 +328,22 @@ LoadbalancerCachedCertificateResponse:
type: string
example: 2019-05-23T11:50:33.000000Z
description: 最早生效时间
readOnly: true
readOnly: true
not_after:
type: string
example: 2020-05-23T11:50:33.000000Z
description: 失效时间
readOnly: true
readOnly: true
common_name:
type: string
example: www.onecloud.com
description: 域名
readOnly: true
readOnly: true
subject_alternative_names:
type: string
example: ''
example: ""
description: 附加域名
readOnly: true
readOnly: true
LoadbalancerCachedCertificateListResponse:
type: object
@@ -342,14 +383,13 @@ LoadbalancerClusterListResponse:
loadbalancerclusters:
type: array
items:
$ref: '#/LoadbalancerCluster'
$ref: "#/LoadbalancerCluster"
LoadbalancerClusterResponse:
type: object
properties:
loadbalancercluster:
type: object
$ref: '#/LoadbalancerCluster'
$ref: "#/LoadbalancerCluster"
LoadbalancerAgent:
type: object
@@ -399,9 +439,9 @@ LoadbalancerAgent:
description: 转发实例自上报的IP地址
readOnly: true
params:
$ref: '#/LoadbalancerAgentParams'
$ref: "#/LoadbalancerAgentParams"
deployment:
$ref: '#/LoadbalancerAgentDeployment'
$ref: "#/LoadbalancerAgentDeployment"
readOnly: true
loadbalancer_acls:
type: string
@@ -448,11 +488,11 @@ LoadbalancerAgentParams:
type: object
properties:
vrrp:
$ref: '#/LoadbalancerAgentParamsVrrp'
$ref: "#/LoadbalancerAgentParamsVrrp"
haproxy:
$ref: '#/LoadbalancerAgentParamsHaproxy'
$ref: "#/LoadbalancerAgentParamsHaproxy"
telegraf:
$ref: '#/LoadbalancerAgentParamsTelegraf'
$ref: "#/LoadbalancerAgentParamsTelegraf"
keepalived_conf_tmpl:
type: string
description: |
@@ -492,7 +532,7 @@ LoadbalancerAgentParamsVrrp:
type: integer
description: |
MASTER状态时发送免费ARP通告的最小间隔
单位秒,默认值27,为0时表示不发送通告
unit: seconds
mininum: 0
@@ -573,20 +613,20 @@ LoadbalancerAgentCreateRequest:
type: string
description: 指定转发实例所属的集群
params:
$ref: '#/LoadbalancerAgentParams'
$ref: "#/LoadbalancerAgentParams"
LoadbalancerAgentListResponse:
type: object
properties:
loadbalanceragents:
type: array
items:
$ref: '#/LoadbalancerAgent'
$ref: "#/LoadbalancerAgent"
LoadbalancerAgentResponse:
type: object
properties:
loadbalanceragent:
type: object
$ref: '#/LoadbalancerAgent'
$ref: "#/LoadbalancerAgent"
LoadbalancerAgentDeployRequest:
type: object
@@ -595,7 +635,7 @@ LoadbalancerAgentDeployRequest:
type: object
properties:
host:
$ref: './ansibleplaybook.yaml#AnsiblePlaybookInventoryHost'
$ref: "./ansibleplaybook.yaml#AnsiblePlaybookInventoryHost"
deploy_method:
type: string
description: 部署方法