Querying the Service Group Member List
Function
This API is used to query service group members.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
GET /v1/{project_id}/service-items
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
set_id |
Yes |
String |
Service group ID |
key_word |
No |
String |
Query field |
limit |
Yes |
Integer |
Number of records displayed on each page |
offset |
Yes |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. |
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
fw_instance_id |
No |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
data |
data object |
Service group member list |
Parameter |
Type |
Description |
|---|---|---|
offset |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. |
limit |
Integer |
Number of records displayed on each page |
total |
Integer |
Total number of records |
set_id |
String |
service set id |
records |
Array of records objects |
Record |
Parameter |
Type |
Description |
|---|---|---|
item_id |
String |
Service member ID |
protocol |
Integer |
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. |
source_port |
String |
Source port |
dest_port |
String |
Destination port |
name |
String |
Service member name |
description |
String |
Service member description |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
Query the member list of the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 7cdebed3-af07-494e-a3c2-b88bb8d58b57.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?set_id=7cdebed3-af07-494e-a3c2-b88bb8d58b57&limit=10&offset=0
Example Responses
Status code: 200
Return value of the service group member list
{
"data" : {
"limit" : 10,
"offset" : 0,
"records" : [ {
"dest_port" : "0",
"item_id" : "805b711d-c558-41e3-aab1-a4b8c3f1f90b",
"name" : "icmp",
"protocol" : 1,
"source_port" : "0"
} ],
"set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57",
"total" : 1
}
}
Status code: 400
Bad Request
{
"error_code" : "CFW.00200005",
"error_msg" : "operation content does not exist"
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Return value of the service group member list |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
