Modifying Group Information

Function

This API is used to modify a group. After a group is created, you can change the name of the component.

URI

PUT /v1/groups/{id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Definition Group ID. Constraints N/A Range The value is a string. It contains 24 characters. Default value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Application name. Constraints The value can contain only letters, digits, hyphens (-), and underscores (_). Range It contains 3 to 50 characters. Default value N/A
sync_mode	Yes	String	Definition Resource synchronization method. Constraints N/A Range MANUAL: indicates manual association. You can manually associate resource data with a group for management. AUTO: indicates intelligent association. You can create resources with the same tag in an enterprise project in the same resource group. Default value The default value is MANUAL.
sync_rules	No	Array of sync_rules objects	Definition Automatic association rule. Constraints N/A Range The selected enterprise project is automatically associated with the existing and future resources of the corresponding tag. Default value N/A
relation_configurations	No	Array of GroupRelationConfiguration objects	Group configuration information

**Table 3** sync_rules
Parameter	Mandatory	Type	Description
ep_id	No	String	Definition Enterprise project ID. Constraints N/A Range Select a project ID that is available inEnterprise Management. Default value N/A
rule_tags	No	String	Definition Tag that is associated with resources. In the enterprise project, only resources that match all the configured tags will be automatically allocated to the application group. Constraints N/A Range This parameter can be customized. Default value N/A

**Table 4** GroupRelationConfiguration
Parameter	Mandatory	Type	Description
type	No	String	Definition Configuration type. Configure the application, component, and environment of the APM service corresponding to the group. APM service performance information can be obtained during fault diagnosis. Constraints N/A Range APM: probe developed by the APM service OTEL: the open-source probe OpenTelemetry SKYWALKING: the open-source probe SkyWalking Default value N/A
parameters	No	Map<String,String>	Definition Configuration parameters. Constraints N/A Range APM configuration parameter app_id->business_id->env_id. The value contains multiple fields. The maximum length is for reference only. Default value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
data	String	Definition Group configuration information. Range N/A

Example Requests

Modify group information.

PUT https://{Endpoint}/v1/groups/{id}

{
  "name" : "test group",
  "sync_mode" : "MANUAL",
  "sync_rules" : null,
  "relation_configurations" : null
}

Example Responses

Status code: 200

The group is modified.

{
  "data" : "685d116902a50263fb2c209e"
}

Status Codes

Status Code	Description
200	The group is modified.

Error Codes

See Error Codes.

Parent topic: Groups

Previous topic: Creating a Group

Next topic: Querying a Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot