Files
cloudpods/docs/schemas/endpoint.yaml
T

112 lines
2.5 KiB
YAML

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: 接入点的描述信息