Application Load Balancer API, REST: TargetGroup.Update
Updates the specified target group.
HTTP request
PATCH https://alb.api.cloud.yandex.net/apploadbalancer/v1/targetGroups/{targetGroupId}
Path parameters
Field |
Description |
targetGroupId |
string Required field. ID of the target group to update. To get the target group ID, make a TargetGroupService.List request. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "string",
"targets": [
{
// Includes only one of the fields `ipAddress`
"ipAddress": "string",
// end of the list of possible fields
"subnetId": "string",
"privateIpv4Address": "boolean"
}
]
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string New name for the target group. |
description |
string New description of the target group. |
labels |
string Target group labels as Existing set of labels is completely replaced by the provided set, so if you just want
|
targets[] |
New list of targets in the target group. Existing list of targets is completely replaced by the specified list, so if you just want to add or remove |
Target
A target resource.
For details about the concept, see documentation.
Field |
Description |
ipAddress |
string IP address of the target. Includes only one of the fields Reference to the target. As of now, targets must only be referred to by their IP addresses. |
subnetId |
string ID of the subnet that the target is connected to. |
privateIpv4Address |
boolean If set, will not require |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"targetGroupId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"name": "string",
"description": "string",
"folderId": "string",
"labels": "string",
"targets": [
{
// Includes only one of the fields `ipAddress`
"ipAddress": "string",
// end of the list of possible fields
"subnetId": "string",
"privateIpv4Address": "boolean"
}
],
"createdAt": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateTargetGroupMetadata
Field |
Description |
targetGroupId |
string ID of the target group that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
TargetGroup
A target group resource.
For details about the concept, see documentation.
Field |
Description |
id |
string ID of the target group. Generated at creation time. |
name |
string Name of the target group. The name is unique within the folder. |
description |
string Description of the target group. |
folderId |
string ID of the folder that the target group belongs to. |
labels |
string Target group labels as |
targets[] |
List of targets in the target group. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
Target
A target resource.
For details about the concept, see documentation.
Field |
Description |
ipAddress |
string IP address of the target. Includes only one of the fields Reference to the target. As of now, targets must only be referred to by their IP addresses. |
subnetId |
string ID of the subnet that the target is connected to. |
privateIpv4Address |
boolean If set, will not require |