Workflow列表所有标签 - ShowWorkflowLabels
功能介绍
Workflow列表所有标签接口用于获取指定项目下所有工作流的标签信息。
该接口适用于以下场景:当用户需要了解项目中所有工作流的标签配置,以便进行资源管理和筛选时,可以通过此接口获取标签列表。使用该接口的前提条件是用户已登录并具有查看工作流标签的权限。响应消息体中包含每个工作流的标签信息,如标签键和值。若用户无权限或项目下无工作流,接口将返回相应的错误信息或空列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。获取该接口关联的CLI示例: hcloud ModelArts ShowWorkflowLabels。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/workflows/labels
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
参数解释:返回的数据条目数。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
offset |
否 |
Integer |
参数解释:数据条目偏移量。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
order |
否 |
String |
参数解释:instance order。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
sort_by |
否 |
String |
参数解释:指定排序字段。 取值范围:可选值:
|
|
template_id |
否 |
String |
参数解释:工作流模板ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of strings |
请求示例
GET https://{endpoint}/v2/{project_id}/workflows/labels?limit=10&offset=0&sort_by=create_time&order=desc
响应示例
状态码:200
返回标签数组
[ "label", "label2" ]
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
返回标签数组 |
错误码
请参见错误码。