检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于管理员创建IAM用户接口,返回如下消息体。为篇幅起见,这里只展示部分内容。
如何调用API 构造请求 认证鉴权 返回结果
状态码 正常 表1 正常时的返回值 状态码 返回值 状态码说明 200 OK POST、GET和PUT操作正常返回。 204 No Content DELETE操作正常返回。 异常 表2 异常时的返回值 状态码 返回值 状态码说明 400 Bad Request 服务器未能处理请求。
相同,所以简洁起见将这两部分省略。 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。
strings 路由表ID列表。 若未指定,返回默认VPC下路由表ID。 更新Gateway类型终端节点服务的终端节点时,显示此参数。 error Array of RoutetableInfoError objects 当修改终端节点子网路由表失败时,返回错误提示信息 表5 RoutetableInfoError
控制访问终端节点的白名单。 若未创建,则返回空列表。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。 enable_whitelist Boolean 是否开启网络ACL隔离。 true:开启网络ACL隔离 false:不开启网络ACL隔离 若未指定,则返回false。 创建连
标签列表,没有标签默认为空数组。 error QueryError object 查询资源返回的异常信息 whitelist Array of strings 控制访问终端节点的白名单。 若未创建,则返回空列表。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。 enable_whitelist
资源标签列表。同一个终端节点服务最多可添加20个标签。 description 否 String 描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 ip_version 否 String 指定终端节点服务的IP版本,仅专业型终端节点服务支持此参数
是否必选 参数类型 描述 id 是 String 终端节点ID,UUID格式字符 description 是 String 描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 connections
objects 提交任务异常时返回的异常信息 enable_policy Boolean 是否允许自定义终端节点策略。 false:不支持设置终端节点策略 true:支持设置终端节点策略 默认为false description String 描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。
String 终端节点所在的VPC的ID。 id 否 String 终端节点的ID,唯一标识。 limit 否 Integer 查询返回终端节点的数量限制,即每页返回的资源个数。 取值范围:0~1000,取值一般为10,20或者50,默认为10。 offset 否 Integer 偏移量。
终端节点服务类型。 基本信息 创建时间 终端节点服务创建时间。 连接管理 终端节点ID 终端节点的ID。 连接管理 报文标识 终端节点ID的标识,用来识别是哪个终端节点。 连接管理 状态 终端节点的状态。 关于终端节点的各个状态,请查看终端节点服务和终端节点有哪些状态?。 连接管理 拥有者 终端节点创建者的账号ID。
open:表示同时开启代理协议“tcp_toa”和“proxy_protocol”。 默认值为“close”。 description 否 String 描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 ip 否 String 接口型VLAN场景服务端IPv4地址或域名 表4 PortList 参数
删除终端节点 功能介绍 删除终端节点。 该接口为异步接口,调用成功会返回200状态码,说明请求已正常下发。 通常删除终端节点需要1~2分钟,可以通过查询终端节点详情查看删除结果 调用方法 请参见如何调用API。 URI DELETE /v1/{project_id}/vpc-en
每个key对应的value可以为空数组但结构体不能缺失。Key不能重复, 同一个key中values不能重复。结果返回包含所有标签的资源列表, key之间是与的关系,key-value结构中value是或的关系。 无tag过滤条件时返回全量数据。 tags_any 否 Array of TagValuesList objects
objects 错误信息。 当终端节点状态异常,即“status”的值为“failed”时,会返回该字段。 whitelist Array of strings 控制访问终端节点的白名单。 若未创建,则返回空列表。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。 enable_whitelist
objects 错误信息。 当终端节点状态异常,即“status”的值为“failed”时,会返回该字段。 whitelist Array of strings 控制访问终端节点的白名单。 若未创建,则返回空列表。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。 enable_whitelist
查询结果中终端节点服务列表的排序方式,取值为: desc:降序排序 asc:升序排序 默认值为desc。 limit 否 Integer 查询返回的终端节点服务数量限制,即每页返回的终端节点服务的个数。 取值范围:0~1000,取值一般为10,20或者50,默认为10。 offset 否 Integer
每个key对应的value可以为空数组但结构体不能缺失。 Key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表, key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 表4 TagValuesList 参数 参数类型 描述 key String
删除终端节点服务 功能介绍 删除终端节点服务。 该接口为异步接口,调用成功会返回200状态码,说明请求已正常下发。通常删除终端节点服务需要1~2分钟,可以通过查询终端节点服务详情查看删除结果。 调用方法 请参见如何调用API。 URI DELETE /v1/{project_id