查看可授权资源¶
查看当前身份可以授权的资源。结果已按所选资源类型和操作过滤,可用于选择后续授权的目标。
GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/iam/permissions/resources
调用前准备¶
先确定要授予的资源类型和操作。
请求参数¶
curl -G "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/iam/permissions/resources" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
--data-urlencode "resource_type=workflow" \
--data-urlencode "action_id=workflow.read" \
--data-urlencode "limit=50"
路径参数
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
workspace_id |
string |
是 |
目标工作区 ID。 |
查询参数
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
resource_type |
string |
是 |
要查看的资源类型。 |
action_id |
string |
是 |
要评估的操作 ID。 |
purpose |
string |
否 |
调用场景标识。 |
parent_id |
string |
否 |
仅查看指定父资源下的资源。 |
q |
string |
否 |
按名称或路径搜索。 |
cursor |
string |
否 |
上一页返回的游标。 |
limit |
integer |
否 |
每页数量,默认 50,范围为 1~100。 |
返回的 data.next_cursor 非空时,将其作为下一次请求的 cursor,并保留其他查询参数。data.next_cursor 为空时停止翻页。
成功响应¶
成功时返回当前身份可选择的资源和能力状态。capability_status 不是 ready 时,应根据 reason_code 展示不支持或暂不可用状态,不能把空列表解释为没有资源。
{
"code": "OK",
"msg": "OK",
"data": {
"items": [],
"next_cursor": "",
"capability_status": "ready",
"reason_code": "",
"request_id": "req-001",
"trace_id": "trace-001"
}
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
成功时为 OK。 |
msg |
string |
成功时为 OK。 |
data.items |
array |
当前页的可授权资源。 |
data.next_cursor |
string |
下一页游标;为空时没有下一页。 |
data.capability_status |
string |
资源适配器状态:ready、unsupported 或 unavailable。 |
data.reason_code |
string |
适配器不可用或不支持时的原因代码。 |
data.request_id |
string |
请求关联 ID。 |
data.trace_id |
string |
链路追踪 ID。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
错误代码。 |
msg |
string |
错误信息。 |
data |
null |
— |