查询元数据列表(1.0.2)
功能介绍
查询元数据列表。
URI
GET /v2/{project_id}/graphs/metadatas
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目编号。获取方法,请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页资源数量的最大值。 约束限制: 不涉及。 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 默认为10。 |
| offset | 否 | Integer | 参数解释: 本次请求的起始位置。 约束限制: 不涉及。 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 默认为0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| schema_count | Integer | 参数解释: 元数据返回个数。请求失败时,字段为空。 取值范围: 不涉及。 |
| schema_list | Array of schema_list objects | 参数解释: 当前project_id下的所有元数据列表。请求失败时,字段为空。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 元数据 ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 元数据名称。 取值范围: 不涉及。 |
| start_time | String | 参数解释: 元数据创建时间。 取值范围: 不涉及。 |
| last_update_time | String | 参数解释: 元数据最后更新时间。 取值范围: 不涉及。 |
| description | String | 参数解释: 元数据描述。 取值范围: 不涉及。 |
| metadata_path | String | 参数解释: 元数据对应路径。 取值范围: 不涉及。 |
| status | String | 参数解释: 元数据是否可用。 取值范围: 不涉及。 |
状态码: 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统提示信息。
取值范围: 不涉及。 |
| error_msg | String | 参数解释: 系统提示信息。
取值范围: 不涉及。 |
请求示例
查询元数据列表。
GET https://{Endpoint}/v2/{project_id}/graphs/metadatas?offset=0&limit=2 响应示例
状态码: 200
成功响应示例
{
"schema_count" : 2,
"schema_list" : [ {
"start_time" : "2022-01-21T10:13:31",
"last_update_time" : "2022-01-21T10:13:31",
"name" : "schema_748e",
"description" : "xxxxx",
"id" : "6634c50e-13aa-4395-8088-6b327f7da694",
"metadata_path" : "devdata/schema_748e.xml",
"status" : "200"
}, {
"start_time" : "2022-04-12T03:15:17",
"last_update_time" : "2022-11-16T08:18:32",
"name" : "unionsdk_schema",
"id" : "6b74069d-3cf3-4cc0-9118-2478e23b87aa",
"metadata_path" : "devdata/unionsdk/unionsdk_schema.xml",
"status" : "200"
} ]
} 状态码: 400
失败响应示例
{
"error_code" : "GES.7006",
"error_msg" : "An internal error occurs in the underlying service of the graph engine."
} 状态码
| 返回值 | 说明 |
|---|---|
| 400 Bad Request | 请求错误 |
| 401 Unauthorized | 鉴权失败 |
| 403 Forbidden | 没有操作权限 |
| 404 Not Found | 找不到资源 |
| 500 Internal Server Error | 服务内部错误 |
| 503 Service Unavailable | 服务不可用 |
错误码
请参见错误码。