setLoadBalancerDescription
    • PDF

    setLoadBalancerDescription

    • PDF

    記事の要約

    VPC環境で利用できます。

    ロードバランサの説明を変更します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/setLoadBalancerDescription

    リクエストヘッダ

    Load Balancer APIで共通して使用されるヘッダの詳細は、Load Balancerの共通ヘッダをご参照ください。

    リクエストクエリパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    regionCodeStringOptional説明を変更する対象のロードバランサインスタンスのリージョンコード
    • getRegionList照会結果の最初のリージョン(デフォルト)
    • getRegionListを通じて確認
    loadBalancerInstanceNoStringRequiredロードバランサインスタンスの番号
    loadBalancerDescriptionStringOptionalロードバランサの説明(Byte)
    • 0~1,000
    responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/setLoadBalancerDescription
    ?regionCode=KR
    &loadBalancerInstanceNo=********
    &loadBalancerDescription=YOUR_DESCRIPTION'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'
    --header 'x-ncp-iam-access-key: {Access Key}'
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの詳細は、LoadBalancerInstanceListをご参照ください。

    レスポンスステータスコード

    NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    <changeLoadBalancerInstanceConfigurationResponse>
        <requestId>133b0622-dd59-4026-ae42-bfbc08e98fae</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <loadBalancerInstanceList>
            <loadBalancerInstance>
                <loadBalancerInstanceNo>********</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>YOUR_DESCRIPTION</loadBalancerDescription>
                <createDate>2024-06-03T17:09:52+0900</createDate>
                <loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
                <loadBalancerDomain>***.com</loadBalancerDomain>
                <loadBalancerIpList>
                    <loadBalancerIp>**.*.*.*</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>*****</vpcNo>
                <regionCode>KR</regionCode>
                <subnetNoList>
                    <subnetNo>******</subnetNo>
                </subnetNoList>
                <loadBalancerSubnetList>
                    <loadBalancerSubnet>
                        <zoneCode>KR-1</zoneCode>
                        <subnetNo>******</subnetNo>
                        <publicIpInstanceNo></publicIpInstanceNo>
                    </loadBalancerSubnet>
                </loadBalancerSubnetList>
                <loadBalancerListenerNoList>
                    <loadBalancerListenerNo>******</loadBalancerListenerNo>
                </loadBalancerListenerNoList>
            </loadBalancerInstance>
        </loadBalancerInstanceList>
    </changeLoadBalancerInstanceConfigurationResponse>
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.