更新时间:2026-02-10 GMT+08:00
分享

启用/停用自定义接入点

功能介绍

该API用于根据传入的project-id和custom_endpoint_id,启用或停用接入点。

接口约束

该功能仅支持“西南-贵阳一”区域。

URI

PUT /v1/{project_id}/maas/services/custom-endpoint/control/{custom_endpoint_id}

表1 路径参数

参数

是否必选

参数类型

描述

project-id

String

参数解释:项目ID。关于如何获取项目ID,请参见获取项目ID和名称

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

custom_endpoint_id

String

参数解释:自定义接入点ID,创建接入点时接口会返回,或者使用查询接口获取。具体操作,请参见创建自定义接入点查询自定义接入点

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:用户Token。通过调用IAM服务的获取用户Token接口获取(响应消息头中X-Subject-Token的值)。具体操作,请参见认证鉴权

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

参数解释:控制接入点启用或停用。

约束限制:不涉及。

取值范围:

  • activate:启用接入点。
  • deactivate:停用接入点。

默认取值:不涉及。

响应参数

  • 成功响应:

    状态码:204,启停成功不返回消息。

  • 错误响应参数如下:

    参数

    参数类型

    描述

    error_msg

    String

    参数解释:错误描述信息。

    取值范围:不涉及。

    error_code

    String

    参数解释:错误码,标识错误类型。

    取值范围:不涉及。

请求示例

此处以启用ID为“c4513589-df2e-4d58-ab0c-d5a6f2******”的接入点为例。

PUT
/v1/{project_id}/maas/services/custom-endpoint/control/c4513589-df2e-4d58-ab0c-d5a6f2******

{
    "action": "activate"
} 

响应示例

  • 成功响应:

    状态码:204,操作成功不返回内容。

  • 错误响应:

    状态码:当接入点ID不存在时,返回404接入点不存在,当参数不符合规范时,返回400报错。

    {
        "error_msg": "Invalid token.",
        "error_code": "ModelArts.0104"
    } 

状态码

请参见状态码

错误码

请参见错误码

相关文档