更新时间:2024-06-20 GMT+08:00

创建图

URI

POST /ges/v1.0/{project_id}/graphs
表1 路径参数

参数

是否必选

类型

说明

project_id

String

项目ID。获取方法请参见获取项目ID

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

graphName

String

图名称。输入长度在4位到32位之间,必须以字母开头,可以包含字母、数字或者下划线,不能包含其他的特殊字符。

idType

String

id的类型, 可选值(hash,fixedLengthString,varString)。

idLength

Integer

当idType取值为fixedLengthString时必填,取值范围:1-128。

sortKeyType

String

必选,可选值如下:

  • “int”:整数类型。
  • “string”:字符串类型,长度需要小于等于40。
  • “varString”:变长字符串,长度无限制。

全图sortKeyType类型统一。

响应参数

表3 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误信息。

errorCode

String

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误码。

result

String

查询成功时值为success,失败时值为failed。

请求示例

POST /ges/v1.0/{project_id}/graphs
{
    "graphName": "xxx",
    "idType": "fixedLengthString",
    "idLength": 20,
    "sortKeyType":"varString"
}

响应示例

状态码: 200

成功响应示例

Http Status Code: 200
{
    "result": "success"
}

状态码: 400

失败响应示例

Http Status Code: 400
{
    "errorMessage": "graph [movie] already exists",
    "errorCode": "GES.8012",
    "result": "failed"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码