文档首页/ 云防火墙 CFW/ API参考（安卡拉区域）/ API/ 服务组管理/ 查询服务组详情
更新时间：2024-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询服务组详情

功能介绍

查询服务组细节

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/service-sets/{set_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目id

set_id

是

String

服务组id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目id，用户支持企业项目后，由企业项目生成的id。

fw_instance_id

否

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

query_service_set_type

否

Integer

查询服务组类型，0表示自定义服务组，1表示预定义服务组

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

ServiceSetDetailResponseDto object

服务组详情数据
表5 ServiceSetDetailResponseDto

参数

参数类型

描述

id

String

服务组id

name

String

服务组名称

description

String

服务组描述信息

service_set_type

Integer

服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库

状态码： 400

表6 响应Body参数

参数

参数类型

描述

data

data object

响应体

trace_id

String

trace id
表7 data

参数

参数类型

描述

id

String

标识ID

请求示例

查询项目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

错误码

请参见错误码。

父主题： 服务组管理