使用GetResourceOverview获取API、网关与风险的资源概览信息-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

获取资源概览信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:GetResourceOverview

get

*全部资源

*

无

请求语法

GET /v1/overview/resources HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
gatewayType	string	否	网关类型	AI

返回参数

名称	类型	描述	示例值
	object	返回结构体。
requestId	string	请求 ID。	DD19A442-93C5-5C97-AFA0-B9C57EBD781B
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object	资源信息。
api	object	API 信息。
totalCount	integer	API 数。	1
publishedCount	integer	已发布 API 数。	1
gateway	object	网关信息。
totalCount	integer	网关实例数。	1
runningCount	integer	运行中的网关数。	1
riskOverview	array<object>	风险概览
	array<object>	某个风险等级下对应的风险详情
riskLevel	string	风险等级	LOW
count	string	该风险等级下的实例数量	1
riskDetails	array<object>	风险详情列表
	object	风险详情
gatewayId	string	网关 id	gw-xxxxxx
gatewayName	string	网关名称	test-gateway
score	string	风险分数	100
riskLevel	string	风险等级	LOW
riskNames	array	风险名称列表
	string	风险名称	网关实例为单节点

示例

正常返回示例

JSON格式

{
  "requestId": "DD19A442-93C5-5C97-AFA0-B9C57EBD781B",
  "code": "Ok",
  "message": "success",
  "data": {
    "api": {
      "totalCount": 1,
      "publishedCount": 1
    },
    "gateway": {
      "totalCount": 1,
      "runningCount": 1
    },
    "riskOverview": [
      {
        "riskLevel": "LOW",
        "count": "1",
        "riskDetails": [
          {
            "gatewayId": "gw-xxxxxx",
            "gatewayName": "test-gateway",
            "score": "100",
            "riskLevel": "LOW",
            "riskNames": [
              "网关实例为单节点"
            ]
          }
        ]
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。