在线服务鉴权 - CreateWorkflowServiceAuth
功能介绍
在线服务鉴权接口用于验证用户是否有权限访问特定的在线服务。
该接口适用于以下场景：当用户需要访问某个在线服务、系统需要验证用户是否有权限，或者在用户登录后检查其访问权限时，用户可通过此接口获取鉴权结果。调用成功后，接口将返回包含鉴权结果的响应。若用户未登录、权限不足或在线服务不存在，接口将返回相应的错误信息。
接口约束
无
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。获取该接口关联的CLI示例： hcloud ModelArts CreateWorkflowServiceAuth。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v2/{project_id}/workflows/service/auth
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
main_service_id |
否 |
String |
参数解释：在线服务ID。获取方法请参见查询服务列表。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
content_id |
否 |
String |
参数解释：Gallery资产ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
consume |
否 |
WorkflowConsume object |
参数解释：消费信息。 约束限制：不涉及。 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
String |
参数解释：认证结果。 取值范围：不涉及。 |
请求示例
对在线服务进行鉴权。设置付费工作流计费周期为“day”，付费工作流可使用的时间为“100”。
POST https://{endpoint}/v2/{project_id}/workflows/service/auth
{
"content_id" : "xxx",
"main_service_id" : "xxx",
"consume" : {
"period" : "day",
"value" : 100
}
}
响应示例
状态码：201
OK
{
"result" : "available"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
OK |
错误码
请参见错误码。
