API网关 APIGAPI网关 APIG

更新时间:2021/06/18 GMT+08:00
分享

修改API分组

功能介绍

修改API分组属性。其中name和remark可修改,其他属性不可修改。

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

PUT

/v1/{project_id}/apigw/instances/{instance_id}/api-groups/{id}

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

project_id

String

项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。

instance_id

String

实例ID,可从API网关控制台的专享版实例信息中获取。

id

String

API分组的编号

请求消息

表3 参数说明

名称

是否必选

类型

说明

name

String

名称。

长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以中文或英文开头。

说明:

中文字符必须为UTF-8或者unicode编码。

remark

String

描述。

字符串长度最大不超过255。

说明:

中文字符必须为UTF-8或者unicode编码。

请求消息样例:

{
	"name": "api_group_001",
	"remark": "分组001"
}

响应消息

表4 参数说明

名称

类型

说明

id

String

编号

name

String

名称

status

Integer

状态

sl_domain

String

系统默认分配的子域名

register_time

Timestamp

创建时间

update_time

Timestamp

最近修改时间

remark

String

描述

call_limits

Integer

流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置

time_interval

Integer

流控时长

time_unit

String

流控的时间单位

url_domains

字典数据类型

分组上绑定的独立域名列表

on_sell_status

Integer

是否已上架云市场:

  • 1:已上架
  • 2:未上架
  • 3:审核中

is_default

Integer

是否为默认分组,默认为非默认分组:

  • 1:默认分组
  • 2:非默认分组
表5 url_domains参数说明

名称

类型

说明

id

String

域名编号

domain

String

访问域名

cname_status

Integer

域名cname状态:

  • 1:未解析
  • 2:解析中
  • 3:解析成功
  • 4:解析失败

ssl_id

String

SSL证书编号

ssl_name

String

SSL证书名称

响应消息样例:

{
	"id": "7efb2b91-155a-4f6a-9f45-c5c95a6e4950",
	"name": "api_group_001",
	"status": 1,
	"sl_domain": "0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com",
	"remark": "分组001",
	"register_time": "2017-12-28T11:44:53Z",
	"update_time": "2017-12-28T11:49:01.048600577Z",
	"on_sell_status": 2,
        "is_default": 2
}

状态码

表6 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Server Internal Error

分享:

    相关文档

    相关产品