查询服务组详情
功能介绍
查询服务组细节
URI
GET /v1/{project_id}/service-sets/{set_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 |
| set_id | 是 | String | 服务组id,可通过获取服务组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 |
| fw_instance_id | 否 | String | 防火墙id,可通过防火墙ID获取方式获取 |
| query_service_set_type | 否 | Integer | 查询服务组类型,0表示自定义服务组,1表示预定义服务组 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。可通过如何获取用户Token获取。 |
| Content-Type | 是 | String | 内容类型,只有application/json的值是适用的 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | ServiceSetDetailResponseDto object | 服务组详情数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 服务组id |
| name | String | 服务组名称 |
| description | String | 服务组描述信息 |
| service_set_type | Integer | 服务组类型,0表示自定义服务组,1表示常用WEB服务,2表示常用远程登录和PING,3表示常用数据库 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429,服务组id为221cfdca-3abf-4c30-ab0d-516a03c70866的服务组的细节
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866 响应示例
状态码:200
查询服务组详情返回值
{
"data" : {
"service_set_type" : 0,
"id" : "221cfdca-3abf-4c30-ab0d-516a03c70866",
"name" : "ceshi2"
}
} 状态码:400
Bad Request
{
"error_code" : "CFW.00200005",
"error_msg" : "操作内容不存在"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询服务组详情返回值 |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。