setLoadBalancerDescription
- Print
- PDF
setLoadBalancerDescription
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Summary
Edit load balancer description.
Request
Request Parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region code - You can decide the region of the load balancer instance to edit the description. - You can obtain the regionCode through the getRegionList action. - Default: Select the first region of the getRegionList search results | |
| loadBalancerInstanceNo | Yes | String | Load balancer instance number - You can obtain the loadBalancerInstanceNo through the getLoadBalancerInstanceList action. | |
| loadBalancerDescription | No | String | Min : 0, Max : 1000 Bytes | Description of the load balancer to edit |
| responseFormatType | No | String | Format type of the response results - Options : xml | json - Default : xml |
Response
Response data type
- LoadBalancerInstanceList type
| LoadBalancerInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List |
| LoadBalancerInstance |
|---|
| private String loadBalancerInstanceNo; |
| private CommonCode loadBalancerInstanceStatus; |
| private CommonCode loadBalancerInstanceOperation; |
| private String loadBalancerInstanceStatusName; |
| private String loadBalancerDescription; |
| private Date createDate; |
| private String loadBalancerName; |
| private String loadBalancerDomain; |
| private LoadBalancerIpList loadBalancerIpList; |
| private CommonCode loadBalancerType; |
| private CommonCode loadBalancerNetworkType; |
| private CommonCode throughputType; |
| private Integer idleTimeout; |
| private String vpcNo; |
| private String regionCode; |
| private SubnetNoList subnetNoList; |
| private List<LoadBalancerSubnet> loadBalancerSubnetList; |
| private LoadBalancerListenerNoList loadBalancerListenerNoList; |
| LoadBalancerIpList |
|---|
| private List |
| SubnetNoList |
|---|
| private List |
| LoadBalancerSubnet |
|---|
| private String zoneCode; |
| private String subnetNo; |
| private String publicIpInstanceNo; |
| LoadBalancerListenerNoList |
|---|
| private List |
Example
Request example
ncloud vloadbalancer setLoadBalancerDescription --regionCode KR --loadBalancerInstanceNo ***887 --loadBalancerDescription test-description
Response example
<setLoadBalancerDescriptionResponse>
<requestId>959a2fe5-fd1b-459a-9af3-df0e51b68e1d</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<loadBalancerInstanceList>
<loadBalancerInstance>
<loadBalancerInstanceNo>***887</loadBalancerInstanceNo>
<loadBalancerInstanceStatus>
<code>USED</code>
<codeName>LB USED state</codeName>
</loadBalancerInstanceStatus>
<loadBalancerInstanceOperation>
<code>NULL</code>
<codeName>LB NULL OP</codeName>
</loadBalancerInstanceOperation>
<loadBalancerInstanceStatusName>Running</loadBalancerInstanceStatusName>
<loadBalancerDescription>test-description</loadBalancerDescription>
<createDate>2020-12-20T19:21:02+0900</createDate>
<loadBalancerName>test-***</loadBalancerName>
<loadBalancerDomain>test-***-***887-***.com</loadBalancerDomain>
<loadBalancerIpList>
<loadBalancerIp>***.***.5.6</loadBalancerIp>
</loadBalancerIpList>
<loadBalancerType>
<code>APPLICATION</code>
<codeName>Application Load Balancer</codeName>
</loadBalancerType>
<loadBalancerNetworkType>
<code>PRIVATE</code>
<codeName>Private</codeName>
</loadBalancerNetworkType>
<throughputType>
<code>SMALL</code>
<codeName>Small</codeName>
</throughputType>
<idleTimeout>60</idleTimeout>
<vpcNo>***04</vpcNo>
<regionCode>KR</regionCode>
<subnetNoList>
<subnetNo>***43</subnetNo>
</subnetNoList>
<loadBalancerSubnetList>
<loadBalancerSubnet>
<zoneCode>KR-1</zoneCode>
<subnetNo>***43</subnetNo>
<publicIpInstanceNo/>
</loadBalancerSubnet>
</loadBalancerSubnetList>
<loadBalancerListenerNoList>
<loadBalancerListenerNo>***961</loadBalancerListenerNo>
</loadBalancerListenerNoList>
</loadBalancerInstance>
</loadBalancerInstanceList>
</setLoadBalancerDescriptionResponse>
Was this article helpful?