Help Center/ Cloud Operations Center/ API Reference/ API/ Application Resource Management/ Groups/ Modifying Group Information
Updated on 2025-10-24 GMT+08:00
View PDF
Share

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    coc:application:updateGroup

    Write

    application *

    -

    -

    -

URI

PUT /v1/groups/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition:

Group ID.

Constraints:

N/A

Value 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 (_).

Value range:

The value is a string. It can contain 3 to 50 characters.

Default value:

N/A

sync_mode

Yes

String

Definition:

Resource synchronization method.

Constraints:

N/A

Value 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

Value range:

The selected enterprise project is intelligently 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

Value 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

Value 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

Value range:

  • APM: probe developed by the APM service

  • OTEL: open-source probe OpenTelemetry

  • SKYWALKING: open-source probe SkyWalking

Default value:

N/A

parameters

No

Map<String,String>

Definition:

Configuration parameters.

Constraints:

N/A

Value 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.

Value range:

N/A

Example Requests

This API is used to modify a group.

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