云应用 cloudapp_api

描述
云应用 API
示例
resource "cloudapp_api" "GetClbOverview" {
  handler_id = cloudapp_api_handler.APIServer.id
  api_name   = "GetLoadBalanceOverview"
  api_desc   = "获取负载均衡情况"
}
参数说明
类型
名称
数据类型
说明
必填
region
string
地域，如：ap-guangzhou，默认使用 provider 中定义的 region
也可以在 resource 中指定地域，覆盖默认设置
必填
handler_id
string
API 处理器（cloudapp_api_handler） ID
必填
api_name
string
API 名称
可选
availability_zone
string
可用区
可选
count
int
资源数量，默认为 1
如果为 0 则不创建资源
可选
activity_id
int
计费活动 ID，保留字段
可选
api_desc
string
API 描述
可选
request_parameters
Schema[]
请求参数
Schema 类型详见：RequestParameterSchema
可选
protocol
"HTTP"
API 协议，目前仅支持 HTTP，可选值：HTTP
生成
id
string
资源实例 ID
生成
create_time
string
资源创建时间
生成
path
string
API 的路径，如 /path
生成
method
string
API 的请求方法，如 GET
数据结构
RequestParameterSchema
描述
请求参数
参数说明
类型
名称
数据类型
说明
必填
name
string
请求参数名称
必填
position
string
参数位置
必填
type
string
参数类型
可选
desc
string
描述
可选
default_value
string
默认值
可选
required
boolean
是否必填

类型	名称	数据类型	说明
必填	region	`string`	地域，如：ap-guangzhou，默认使用 `provider` 中定义的 region 也可以在 `resource` 中指定地域，覆盖默认设置
	必填	handler_id	`string`	API 处理器（cloudapp_api_handler） ID
	必填	api_name	`string`	API 名称
可选	availability_zone	`string`	可用区
	可选	count	`int`	资源数量，默认为 1 如果为 0 则不创建资源
	可选	activity_id	`int`	计费活动 ID，保留字段
	可选	api_desc	`string`	API 描述
	可选	request_parameters	`Schema[]`	请求参数 Schema 类型详见：RequestParameterSchema
	可选	protocol	`"HTTP"`	API 协议，目前仅支持 HTTP，可选值：HTTP
生成	id	`string`	资源实例 ID
	生成	create_time	`string`	资源创建时间
	生成	path	`string`	API 的路径，如 /path
	生成	method	`string`	API 的请求方法，如 GET

cloudapp_api

本页目录：

描述

示例

参数说明

数据结构

RequestParameterSchema

描述

参数说明