setTargetGroupDescription
- Print
- PDF
setTargetGroupDescription
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Summary
Edit the target group description.
Request
Request Parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region code You can decide the region of a target group where the description will be edited. You can obtain the regionCode through the getRegionList action. Default: Select the first region of the getRegionList search results | |
| targetGroupNo | Yes | String | Target group number You can obtain the targetGroupNo through the getTargetGroupList action. | |
| targetGroupDescription | No | String | Min : 0, Max : 1000 Bytes | Description about the target group to edit |
| responseFormatType | No | String | Format type of the response results Options : xml | json Default : xml |
Response
Response data type
- TargetGroupList type
| TargetGroupList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List |
| TargetGroup |
|---|
| private String targetGroupNo; |
| private String targetGroupName; |
| private CommonCode targetType; |
| private String vpcNo; |
| private CommonCode targetGroupProtocolType; |
| private Integer targetGroupPort; |
| private String targetGroupDescription; |
| private Boolean useStickySession; |
| private Boolean useProxyProtocol; |
| private CommonCode algorithmType; |
| private Date createDate; |
| private String regionCode; |
| private String loadBalancerInstanceNo; |
| private CommonCode healthCheckProtocolType; |
| private Integer healthCheckPort; |
| private String healthCheckUrlPath; |
| private CommonCode healthCheckHttpMethodType; |
| private Integer healthCheckCycle; |
| private Integer healthCheckUpThreshold; |
| private Integer healthCheckDownThreshold; |
| private TargetNoList targetNoList; |
| TargetNoList |
|---|
| private List |
Example
Request example
ncloud vloadbalancer setTargetGroupDescription --regionCode KR --targetGroupNo ***095 --targetGroupDescription test-description
Response example
<setTargetGroupDescriptionResponse>
<requestId>b644e5ed-6ca8-48d5-9b7f-2a3549ef3c96</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<targetGroupList>
<targetGroup>
<targetGroupNo>***095</targetGroupNo>
<targetGroupName>test-***</targetGroupName>
<targetType>
<code>VSVR</code>
<codeName>Server (VPC)</codeName>
</targetType>
<vpcNo>***04</vpcNo>
<targetGroupProtocolType>
<code>HTTP</code>
<codeName>HTTP protocol</codeName>
</targetGroupProtocolType>
<targetGroupPort>80</targetGroupPort>
<targetGroupDescription>test-description</targetGroupDescription>
<useStickySession>false</useStickySession>
<useProxyProtocol>false</useProxyProtocol>
<algorithmType>
<code>RR</code>
<codeName>Round Robin</codeName>
</algorithmType>
<createDate>2020-12-17T21:06:45+0900</createDate>
<regionCode>KR</regionCode>
<loadBalancerInstanceNo></loadBalancerInstanceNo>
<healthCheckProtocolType>
<code>HTTP</code>
<codeName>HTTP protocol</codeName>
</healthCheckProtocolType>
<healthCheckPort>80</healthCheckPort>
<healthCheckUrlPath>/</healthCheckUrlPath>
<healthCheckHttpMethodType>
<code>GET</code>
<codeName>get</codeName>
</healthCheckHttpMethodType>
<healthCheckCycle>30</healthCheckCycle>
<healthCheckUpThreshold>2</healthCheckUpThreshold>
<healthCheckDownThreshold>2</healthCheckDownThreshold>
<targetNoList/>
</targetGroup>
</targetGroupList>
</setTargetGroupDescriptionResponse>
Was this article helpful?