启用/停用自定义接入点
功能介绍
该API用于根据传入的project-id和custom_endpoint_id,启用或停用接入点。
接口约束
该功能仅支持“西南-贵阳一”区域。
URI
PUT /v1/{project_id}/maas/services/custom-endpoint/control/{custom_endpoint_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project-id |
是 |
String |
参数解释:项目ID。关于如何获取项目ID,请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
custom_endpoint_id |
是 |
String |
参数解释:自定义接入点ID,创建接入点时接口会返回,或者使用查询接口获取。具体操作,请参见创建自定义接入点或查询自定义接入点。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释:用户Token。通过调用IAM服务的获取用户Token接口获取(响应消息头中X-Subject-Token的值)。具体操作,请参见认证鉴权。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
action |
是 |
String |
参数解释:控制接入点启用或停用。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
- 错误响应参数如下:
参数
参数类型
描述
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"
}
响应示例
状态码
请参见状态码。
错误码
请参见错误码。