云服务器内容精选
-
对象模型 本节介绍API分组的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型 是否必选 ID String API分组编号 R - NAME String API分组名称 CRU 是 STATUS Integer API分组状态 1 正常状态 2 禁用状态 3 已删除 默认值1 该字段暂时废弃 R - SL_DOMAIN String API分组的子 域名 ,由API网关分配,用户不可填写和修改 R - PROJECT_ID String 创建该API分组的租户编号,即API分组的所有者 - - DOMAIN_NAME String 创建该API分组的租户名称 - - REGISTER_TIME Timestamp API分组创建时间,由系统默认生成 R - UPDATE_TIME Timestamp 最近一次修改时间 R - REMARK String 描述,简述该API分组的功能、作用等 CRU 否 THROTTLE_ID String 流控策略编号,限定该分组在一定时间内可以被访问的次数 说明: 该字段表示该分组下的所有API单位时间内总共能够访问多少次,并非表示每个API单位时间内分别能够访问多少次。 RU - 父主题: API分组管理(待下线)
-
请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String API分组的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String API分组描述。 长度最大不超过255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: {"name": "api_group_001","remark": "分组1"}
-
响应消息 表4 参数说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态 sl_domain String 系统默认分配的子域名 register_time Timestamp 创建时间 update_time Timestamp 最近修改时间 remark String 描述 on_sell_status Integer 是否已上架云商店: 1:已上架 2:未上架 3:审核中 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains 字典数据类型 分组上绑定的独立域名列表 is_default Integer 是否为默认分组,默认为非默认分组: 1:默认分组 2:非默认分组 响应消息样例: {"id": "7efb2b91-155a-4f6a-9f45-c5c95a6e4950","name": "api_group_001","status": 1,"sl_domain": "0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com","remark": "分组1","register_time": "2017-12-28T11:44:53.831282304Z","update_time": "2017-12-28T11:44:53.831283436Z","on_sell_status": 2, "is_default": 2}
-
URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/instances/{instance_id}/api-groups URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。