校验API分组名称是否存在 - CheckApiGroupsV2
功能介绍
校验API分组名称是否存在。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。 
    授权项 访问级别 资源类型(*为必须) 条件键 别名 依赖的授权项 apig:apiGroup:checkApiGroupNameExistOrNot Read instance * g:ResourceTag/<tag-key> - apig:groups:get
 apig:instance:get 
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/check
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方式请参见获取项目ID。 | 
| instance_id | 是 | String | 实例ID,在API网关控制台的“实例信息”中获取。 | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| group_name | 是 | String | 待校验的API分组名称 | 
| roma_app_id | 否 | String | 集成应用ID 暂不支持 | 
响应参数
状态码:204
No Content
状态码:400
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码 | 
| error_msg | String | 错误描述 | 
状态码:401
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码 | 
| error_msg | String | 错误描述 | 
状态码:403
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码 | 
| error_msg | String | 错误描述 | 
状态码:404
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码 | 
| error_msg | String | 错误描述 | 
状态码:500
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码 | 
| error_msg | String | 错误描述 | 
请求示例
{
  "group_name" : "ApiGroup_demo"
}
 响应示例
状态码:400
Bad Request
{
  "error_code" : "APIG.3201",
  "error_msg" : "The API group name already exists"
}
  状态码:401
Unauthorized
{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}
  状态码:403
Forbidden
{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}
  状态码:404
Not Found
{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}
  状态码:500
Internal Server Error
{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}
 状态码
| 状态码 | 描述 | 
|---|---|
| 204 | No Content | 
| 400 | Bad Request | 
| 401 | Unauthorized | 
| 403 | Forbidden | 
| 404 | Not Found | 
| 500 | Internal Server Error | 
错误码
请参见错误码。
 
  