
# 查询图概要信息(1.0.0) - ShowGraphSummary
#### 功能介绍
查询图的点数和边数等概要信息。
#### URI
GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details={labelDetails}
表1路径参数 
| 参数            | 是否必选 | 类型      | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| project_id    | 是    | String  | **参数解释：** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-ges/ges_03_0111.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及。                                                                 |
| graph_name    | 是    | String  | **参数解释：** 图名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                                          |
| label_details | 否    | Boolean | **参数解释：** 是否返回不同label下点边的数目信息。 **约束限制：** 不涉及。 **取值范围：** - false。  - 为true时，返回不同label的点边数目。   **默认取值：** 默认为false。 |
   
#### 请求参数
无
#### 响应参数
表2响应Body参数说明 
| 参数           | 类型     | 说明                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|
| errorMessage | String | **参数解释**： 系统提示信息。 - 执行成功时，字段可能为空。  - 执行失败时，用于显示错误信息。   **取值范围**： 不涉及。     |
| errorCode    | String | **参数解释**： 系统提示信息。 - 执行成功时，字段可能为空。  - 执行失败时，用于显示错误码。   **取值范围**： 不涉及。 |
| data         | Object | **参数解释**： 查询结果。请求失败时，该字段为空。 **取值范围**： 不涉及。                                                                                                                                                                                            |
   
表3data参数说明 
| 参数                   | 类型      | 说明                                                                                                                                                                                                       |
|:---|:---|:---|
| vertexNum            | Integer | **参数解释**： 图的点数。 **取值范围**： 不涉及。                                                                                   |
| edgeNum              | Integer | **参数解释**： 图的边数。 **取值范围**： 不涉及。                                                                                    |
| labelDetails（2.2.14） | Object  | **参数解释**： 不同label下的点边数目信息。若需要正常显示此字段，请按照[labelDetails数据各要素说明]建立点边索引。 **取值范围**： 不涉及。 |
   
 表4执行成功时，labelDetails数据各要素说明 
| 参数            | 类型     | 说明                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|
| labelInVertex | Object | **参数解释**： 不同label下面点的数目，若某label下点的数目为0则不显示。 若需要响应中包含该要素，请参考[新建索引](https://support.huaweicloud.com/api-ges/ges_03_0057.html)，新建索引时索引类型为"GlobalCompositeVertexIndex "，hasLabel为"true",属性列表置空。 **取值范围**： 不涉及。 |
| labelInEdge   | Object | **参数解释**： 不同label下面边的数目，若某label下边的数目为0则不显示。 若需要响应中包含该要素，请参考[新建索引](https://support.huaweicloud.com/api-ges/ges_03_0057.html)，新建索引时索引类型为"GlobalCompositeEdgeIndex "，hasLabel为"true",属性列表置空。 **取值范围**： 不涉及。      |
| errorMessage  | String | **参数解释**： 系统提示信息。 - 执行成功时，字段可能为空。  - 执行失败时，用于显示错误信息。   **取值范围**： 不涉及。                |
| errorCode     | String | **参数解释**： 系统提示信息。 - 执行成功时，字段可能为空。  - 执行失败时，用于显示错误码。   **取值范围**： 不涉及。             |
   
#### 请求示例
查询图的点数和边数等概要信息，true表示返回不同label的点边数目。
```
GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details=true
```
![](https://support.huaweicloud.com/api-ges/public_sys-resources/note_3.0-zh-cn.png)
SERVER_URL：图的访问地址，取值请参考[业务面API使用限制](https://support.huaweicloud.com/api-ges/ges_03_0139.html)。
#### 响应示例
**状态码： 200**
- 成功响应示例1（返回不同label下点边数目的情况）
  ```
  Http Status Code: 200
  {
      "data": {
          "vertexNum": 146,
          "labelDetails": {
              "labelInVertex": {
                  "movie": 46,
                  "user": 100
              },
              "labelInEdge": {
                  "default": 450,
                  "rate": 1209
              }
          },
          "edgeNum": 1659
      }
  }
  ```
  

- 成功响应示例2（无法提供不同label下点边数目的情况）
  ```
  Http Status Code: 200
  {
      "data": {
          "vertexNum": 146,
          "labelDetails": {
              "errorMessage": "Label index in vertices is not found.Label index in edges is not found.",
              "errorCode": "GES.8017"
          },
          "edgeNum": 1659
      }
  }
  ```
  
- 成功响应示例3（只有不同label下点数目正常返回的情况）
  ```
  Http Status Code: 200
  {
      "data": {
          "vertexNum": 146,
          "labelDetails": {
              "errorMessage": "Label index in edges is not found.",
              "labelInVertex": {
                  "movie": 46,
                  "user": 100
              },
              "errorCode": "GES.8017"
          },
          "edgeNum": 1659
      }
  }
  ```
  
**状态码： 400**
失败响应示例
```
Http Status Code: 400
{
    "errorMessage": "Not found. Please check the input parameters.",
    "errorCode": "GES.8000"
}
```
#### 状态码
| 返回值                       | 说明      |
|:---|:---|
| 400 Bad Request           | 请求错误。   |
| 401 Unauthorized          | 鉴权失败。   |
| 403 Forbidden             | 没有操作权限。 |
| 404 Not Found             | 找不到资源。  |
| 500 Internal Server Error | 服务内部错误。 |
| 503 Service Unavailable   | 服务不可用。  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ges/ges_03_0110.html)。
