Deleting a Service Group Member¶
Function¶
This API is used to delete a member from a service group.
URI¶
DELETE /v1/{project_id}/service-items/{item_id}
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. |
item_id | Yes | String | Service group member ID, which can be obtained by calling the API for querying the service group member list. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects). |
Parameter | Mandatory | Type | Description |
---|---|---|---|
enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
fw_instance_id | No | String | Firewall ID, which can be obtained by referring to Obtaining a Firewall ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. You can obtain the token by referring to Obtaining a User Token. |
Content-Type | Yes | String | Content type. It can only be set to application/json. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
data | Delete service group member data. |
Parameter | Type | Description |
---|---|---|
id | String | Service group member ID. |
name | String | Service group member name. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error description. |
Example Requests¶
Delete the service group member whose ID is 6b37ed55-1e21-46a5-a7dc-a59ef418d359 from project 9d80d070b6d44942af73c9c3d38e0429.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items/6b37ed55-1e21-46a5-a7dc-a59ef418d359
Example Responses¶
Status code: 200
Information returned for service group member deletion.
{
"data" : {
"id" : "26f562c4-fe11-43d0-9654-f54298d5b12e",
"name" : "0|1"
}
}
Status code: 400
Bad Request
{
"error_code" : "CFW.0020016",
"error_msg" : "Incorrect instance status."
}
Status Codes¶
Status Code | Description |
---|---|
200 | Information returned for service group member deletion. |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.