API描述

<section class="section" id="Description__section_ots_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoints</h2> <p class="p"><span class="ph" id="Description___Toc105423970"><strong class="ph b">接口描述</strong></span></p> <p class="p">查询终端节点列表。</p> <p class="p"><span class="ph" id="Description___Toc105423971"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_pts_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">regionId</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">地域 UUID</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">name</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">名称</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">address</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">IP 地址</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">vpcName</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">VPC 名称</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">pageNumber</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">分页页码,最小值为1,默认值为1。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">pageSize</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">分页大小,最小值为1,最大值为100,默认值为10。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105423972"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_qts_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">total</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">数据总量</p> </td> <td class="entry"></td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">List< EndpointResponse</p> <p class="p"> ></p> </td> <td class="entry"> <p class="p">终端节点信息列表</p> </td> <td class="entry"></td> </tr> </tbody></table> </section> <section class="section" id="Description__section_rts_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoints/{id}</h2> <p class="p"><span class="ph" id="Description___Toc105423974"><strong class="ph b">接口描述</strong></span></p> <p class="p">查询终端节点详情。</p> <p class="p"><span class="ph" id="Description___Toc105423975"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105423976"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_sts_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">EndpointResponse</p> </td> <td class="entry"> <p class="p">终端节点信息</p> </td> <td class="entry"></td> </tr> </tbody></table> </section> <section class="section" id="Description__section_tts_tjv_wtb"><h2 class="doc-tairway">POST /web/endpoints</h2> <p class="p"><span class="ph" id="Description___Toc105423978"><strong class="ph b">接口描述</strong></span></p> <p class="p">创建终端节点</p> <p class="p"><span class="ph" id="Description___Toc105423979"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_uts_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">subnetId</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">是</p> </td> <td class="entry"> <p class="p">子网ID</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">displayName</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">显示名称。最多支持100个字符。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">serviceId</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">是</p> </td> <td class="entry"> <p class="p">终端节点服务ID</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">enableWhitelist</p> </td> <td class="entry"> <p class="p">Boolean</p> </td> <td class="entry"> <p class="p">是</p> </td> <td class="entry"> <p class="p">是否开启访问控制功能。取值为:</p> <ul class="ul" id="Description__ul_vts_tjv_wtb"> <li class="li">true:开启访问控制功能</li> <li class="li">false:关闭访问控制功能</li> </ul> <p class="p">默认值为false。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">whitelists</p> </td> <td class="entry"> <p class="p">List<String></p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">白名单列表。当白名单列表不为空时,enableWhitelist必须为true,单次最大可添加10条。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105423980"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_wts_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">EndpointResponse</p> </td> <td class="entry"> <p class="p">终端节点信息</p> </td> <td class="entry"></td> </tr> </tbody></table> </section> <section class="section" id="Description__section_xts_tjv_wtb"><h2 class="doc-tairway">DELETE /web/endpoints/{id}</h2> <p class="p"><span class="ph" id="Description___Toc105423982"><strong class="ph b">接口描述</strong></span></p> <p class="p">删除终端节点</p> <p class="p"><span class="ph" id="Description___Toc105423983"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105423984"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_yts_tjv_wtb"><h2 class="doc-tairway">PUT /web/endpoints/{id}</h2> <p class="p"><span class="ph" id="Description___Toc105423986"><strong class="ph b">接口描述</strong></span></p> <p class="p">修改终端节点</p> <p class="p"><span class="ph" id="Description___Toc105423987"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_zts_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">displayName</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">显示名称</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">enableWhitelist</p> </td> <td class="entry"> <p class="p">Boolean</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">是否开启访问控制功能。取值为:</p> <ul class="ul" id="Description__ul_a5s_tjv_wtb"> <li class="li">true:开启访问控制功能</li> <li class="li">false:关闭访问控制功能</li> </ul> <p class="p">默认值为false。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105423988"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_b5s_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoints/{id}/service</h2> <p class="p"><span class="ph" id="Description___Toc105423990"><strong class="ph b">接口描述</strong></span></p> <p class="p">终端节点详情的服务信息</p> <p class="p"><span class="ph" id="Description___Toc105423991"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105423992"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_c5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">EndpointServiceResponse</p> </td> <td class="entry"> <p class="p">终端节点服务信息</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> </section> <section class="section" id="Description__section_d5s_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoints/{id}/whitelists</h2> <p class="p"><span class="ph" id="Description___Toc105423994"><strong class="ph b">接口描述</strong></span></p> <p class="p">查询终端节点白名单列表</p> <p class="p"><span class="ph" id="Description___Toc105423995"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_e5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">pageNumber</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">分页页码,最小值为1,默认值为1。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">pageSize</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">分页大小,最小值为1,最大值为100,默认值为10。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105423996"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_f5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">total</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">数据总量</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">List< WhitelistResponse</p> <p class="p"> ></p> </td> <td class="entry"> <p class="p">白名单列表</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> </section> <section class="section" id="Description__section_g5s_tjv_wtb"><h2 class="doc-tairway">POST /web/endpoints/{id}/whitelists</h2> <p class="p"><span class="ph" id="Description___Toc105423998"><strong class="ph b">接口描述</strong></span></p> <p class="p">添加白名单</p> <p class="p"><span class="ph" id="Description___Toc105423999"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_h5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">addresses</p> </td> <td class="entry"> <p class="p">List<String></p> </td> <td class="entry"> <p class="p">是</p> </td> <td class="entry"> <p class="p">IP地址列表</p> </td> <td class="entry"></td> </tr> <tr class="row"> <td class="entry"> <p class="p">description</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">描述。最多支持100个字符。</p> </td> <td class="entry"></td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105424000"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_i5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">total</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">数据总量</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">List< WhitelistResponse</p> <p class="p"> ></p> </td> <td class="entry"> <p class="p">白名单列表</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> </section> <section class="section" id="Description__section_j5s_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoints/{id}/whitelists/{whitelistId}</h2> <p class="p"><span class="ph" id="Description___Toc105424002"><strong class="ph b">接口描述</strong></span></p> <p class="p">查询白名单详情</p> <p class="p"><span class="ph" id="Description___Toc105424003"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105424004"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_k5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">WhitelistResponse</p> </td> <td class="entry"> <p class="p">白名单信息</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> </section> <section class="section" id="Description__section_l5s_tjv_wtb"><h2 class="doc-tairway">DELETE /web/endpoints/{id}/whitelists/{whitelistId}</h2> <p class="p"><span class="ph" id="Description___Toc105424006"><strong class="ph b">接口描述</strong></span></p> <p class="p">删除白名单</p> <p class="p"><span class="ph" id="Description___Toc105424007"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105424008"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_m5s_tjv_wtb"><h2 class="doc-tairway">PUT /web/endpoints/{id}/whitelists/{whitelistId}</h2> <p class="p"><span class="ph" id="Description___Toc105424010"><strong class="ph b">接口描述</strong></span></p> <p class="p">修改白名单</p> <p class="p"><span class="ph" id="Description___Toc105424011"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_n5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">description</p> </td> <td class="entry"> <p class="p">string</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">描述</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105424012"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_o5s_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoint-services</h2> <p class="p"><span class="ph" id="Description___Toc105424014"><strong class="ph b">接口描述</strong></span></p> <p class="p">查询终端节点服务列表。</p> <p class="p"><span class="ph" id="Description___Toc105424015"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_p5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">regionId</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">地域 UUID</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">name</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">名称</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">address</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">IP 地址</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">vpcName</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">VPC 名称</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">pageNumber</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">分页页码,最小值为1,默认值为1。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">pageSize</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">分页大小,最小值为1,最大值为100,默认值为10。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105424016"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_q5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">total</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">数据总量</p> </td> <td class="entry"></td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">List< EndpointResponse</p> <p class="p"> ></p> </td> <td class="entry"> <p class="p">终端节点信息列表</p> </td> <td class="entry"></td> </tr> </tbody></table> </section> <section class="section" id="Description__section_r5s_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoint-services/{id}</h2> <p class="p"><span class="ph" id="Description___Toc105424018"><strong class="ph b">接口描述</strong></span></p> <p class="p">查询终端节点详情。</p> <p class="p"><span class="ph" id="Description___Toc105424019"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105424020"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_s5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">EndpointResponse</p> </td> <td class="entry"> <p class="p">终端节点信息</p> </td> <td class="entry"></td> </tr> </tbody></table> </section> <section class="section" id="Description__section_t5s_tjv_wtb"><h2 class="doc-tairway">POST /web/endpoint-services</h2> <p class="p"><span class="ph" id="Description___Toc105424022"><strong class="ph b">接口描述</strong></span></p> <p class="p">创建终端节点服务</p> <p class="p"><span class="ph" id="Description___Toc105424023"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_u5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">subnetId</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">是</p> </td> <td class="entry"> <p class="p">子网ID</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">displayName</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">显示名称。最多支持100个字符。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">serviceId</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">是</p> </td> <td class="entry"> <p class="p">终端节点服务ID</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">enableWhitelist</p> </td> <td class="entry"> <p class="p">Boolean</p> </td> <td class="entry"> <p class="p">是</p> </td> <td class="entry"> <p class="p">是否开启访问控制功能。取值为:</p> <ul class="ul" id="Description__ul_v5s_tjv_wtb"> <li class="li">true:开启访问控制功能</li> <li class="li">false:关闭访问控制功能</li> </ul> <p class="p">默认值为false。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">whitelists</p> </td> <td class="entry"> <p class="p">List<String></p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">白名单列表,当白名单列表不为空时,enableWhitelist必须为true,单次最大可添加10条。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105424024"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_w5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">EndpointResponse</p> </td> <td class="entry"> <p class="p">终端节点信息</p> </td> <td class="entry"></td> </tr> </tbody></table> </section> <section class="section" id="Description__section_x5s_tjv_wtb"><h2 class="doc-tairway">DELETE /web/endpoint-services/{id}</h2> <p class="p"><span class="ph" id="Description___Toc105424026"><strong class="ph b">接口描述</strong></span></p> <p class="p">删除终端节点服务</p> <p class="p"><span class="ph" id="Description___Toc105424027"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105424028"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_y5s_tjv_wtb"><h2 class="doc-tairway">PUT /web/endpoint-services/{id}</h2> <p class="p"><span class="ph" id="Description___Toc105424030"><strong class="ph b">接口描述</strong></span></p> <p class="p">修改终端节点服务</p> <p class="p"><span class="ph" id="Description___Toc105424031"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_z5s_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">displayName</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">显示名称</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">enableWhitelist</p> </td> <td class="entry"> <p class="p">Boolean</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">是否开启访问控制功能。取值为:</p> <ul class="ul" id="Description__ul_avs_tjv_wtb"> <li class="li">true:开启访问控制功能</li> <li class="li">false:关闭访问控制功能</li> </ul> <p class="p">默认值为false。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"> </p> <p class="p"><span class="ph" id="Description___Toc105424032"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_bvs_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoint-services/selects</h2> <p class="p"><span class="ph" id="Description___Toc105424034"><strong class="ph b">接口描述</strong></span></p> <p class="p">创建终端节点时,查询终端节点服务选项列表</p> <p class="p"><span class="ph" id="Description___Toc105424035"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105424036"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_cvs_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">EndpointServiceResponse</p> </td> <td class="entry"> <p class="p">终端节点服务信息</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> </section> <section class="section" id="Description__section_dvs_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoint-services/{id}/links</h2> <p class="p"><span class="ph" id="Description___Toc105424038"><strong class="ph b">接口描述</strong></span></p> <p class="p">查询终端节点服务的连接列表</p> <p class="p"><span class="ph" id="Description___Toc105424039"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_evs_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">pageNumber</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">分页页码,最小值为1,默认值为1。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">pageSize</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">分页大小,最小值为1,最大值为100,默认值为10。</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105424040"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_fvs_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">total</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">数据总量</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">List<ServiceLinkResponse</p> <p class="p"> ></p> </td> <td class="entry"> <p class="p">连接列表</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> </section> <section class="section" id="Description__section_gvs_tjv_wtb"><h2 class="doc-tairway">PUT /web/endpoint-services/{id}/links/{endpointId}/reject</h2> <p class="p"><span class="ph" id="Description___Toc105424042"><strong class="ph b">接口描述</strong></span></p> <p class="p">终端节点服务拒绝连接</p> <p class="p"><span class="ph" id="Description___Toc105424043"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105424044"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_hvs_tjv_wtb"><h2 class="doc-tairway">PUT /web/endpoint-services/{id}/links/{endpointId}/accept</h2> <p class="p"><span class="ph" id="Description___Toc105424046"><strong class="ph b">接口描述</strong></span></p> <p class="p">终端节点服务接收连接</p> <p class="p"><span class="ph" id="Description___Toc105424047"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105424048"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_ivs_tjv_wtb"><h2 class="doc-tairway">GET /web/endpoint-services/{id}/auths</h2> <p class="p"><span class="ph" id="Description___Toc105424050"><strong class="ph b">接口描述</strong></span></p> <p class="p">查询终端节点服务的授权列表</p> <p class="p"><span class="ph" id="Description___Toc105424051"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_jvs_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">tenantName</p> </td> <td class="entry"> <p class="p">String</p> </td> <td class="entry"> <p class="p">否</p> </td> <td class="entry"> <p class="p">租户名称</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105424052"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section> <section class="section" id="Description__section_kvs_tjv_wtb"><h2 class="doc-tairway">POST /web/endpoint-services/{id}/auths</h2> <p class="p"><span class="ph" id="Description___Toc105424054"><strong class="ph b">接口描述</strong></span></p> <p class="p">终端节点服务添加授权</p> <p class="p"><span class="ph" id="Description___Toc105424055"><strong class="ph b">请求参数</strong></span></p> <table class="table" id="Description__table_lvs_tjv_wtb"><caption></caption><colgroup><col><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">是否必须</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">tenantBeans</p> </td> <td class="entry"> <p class="p">List<TenantBean></p> </td> <td class="entry"> <p class="p">是</p> </td> <td class="entry"> <p class="p">授权账号信息列表</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> <p class="p"><span class="ph" id="Description___Toc105424056"><strong class="ph b">响应参数</strong></span></p> <table class="table" id="Description__table_mvs_tjv_wtb"><caption></caption><colgroup><col><col><col><col></colgroup><tbody class="tbody"> <tr class="row"> <td class="entry"> <p class="p"><strong class="ph b">参数名称</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数类型</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">参数描述</strong></p> </td> <td class="entry"> <p class="p"><strong class="ph b">备注</strong></p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">total</p> </td> <td class="entry"> <p class="p">Integer</p> </td> <td class="entry"> <p class="p">数据总量</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> <tr class="row"> <td class="entry"> <p class="p">data</p> </td> <td class="entry"> <p class="p">List<ServiceAuthResponse</p> <p class="p"> ></p> </td> <td class="entry"> <p class="p">授权列表</p> </td> <td class="entry"> <p class="p"> </p> </td> </tr> </tbody></table> </section> <section class="section" id="Description__section_nvs_tjv_wtb"><h2 class="doc-tairway">DELETE /web/endpoint-services/{id}/auths/{authId}</h2> <p class="p"><span class="ph" id="Description___Toc105424058"><strong class="ph b">接口描述</strong></span></p> <p class="p">终端节点服务删除授权</p> <p class="p"><span class="ph" id="Description___Toc105424059"><strong class="ph b">请求参数</strong></span></p> <p class="p">无</p> <p class="p"><span class="ph" id="Description___Toc105424060"><strong class="ph b">响应参数</strong></span></p> <p class="p">无</p> </section>
以上内容是否解决了您的问题?
请补全提交信息!
联系我们

电话咨询

400-151-8800

邮件咨询

fincloud@ocft.com

在线客服

工单支持

解决云产品相关技术问题