tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeModifyInstanceBundles

Last updated: 2023-12-04 16:31:57

    1. API Description

    Domain name for API request: lighthouse.tencentcloudapi.com.

    This API is used to query the list of package options of an instance.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeModifyInstanceBundles.
    Version Yes String Common Params. The value used for this API: 2020-03-24.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID.
    Filters.N No Array of Filter Filter list
  • bundle-id
    • Filter by the bundle ID.
    Type: String
    Required: No
  • support-platform-type
    • Filter by the OS type.
    Valid values: LINUX_UNIX (Linux or Unix), WINDOWS (Windows)
    Type: String
    Required: No
  • bundle-type
    • Filter by the bundle type.
    Valid values: GENERAL_BUNDLE (General bundle), STORAGE_BUNDLE (Storage bundle), ENTERPRISE_BUNDLE (Enterprise bundle), EXCLUSIVE_BUNDLE (Dedicated bundle), BEFAST_BUNDLE (BeFast bundle)
    Type: String
    Required: No
  • bundle-state
    • Filter by the bundle status.
    Valid values: ONLINE, OFFLINE
    Type: String
    Required: No
    Each request can contain up to 10 Filters, and each filter can have up to 5 Filter.Values.
    Offset No Integer Offset. Default value: 0. For more information on Offset, please see the relevant section in Overview.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, please see the relevant section in the API Overview.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of matched instances.
    ModifyBundleSet Array of ModifyBundle New package details
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of bundle options of instance

    Input Example

    POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeModifyInstanceBundles
<Common request parameters>

{
    "InstanceId": "lhins-f4s3n38h"
}

    Output Example

    {
    "Response": {
        "ModifyBundleSet": [
            {
                "Bundle": {
                    "BundleDisplayLabel": "NORMAL",
                    "BundleId": "bundle_ntp_small2_500",
                    "BundleSalesState": "AVAILABLE",
                    "BundleType": "GENERAL_BUNDLE",
                    "CPU": 1,
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 3,
                    "Memory": 2,
                    "MonthlyTraffic": 500,
                    "Price": {
                        "InstancePrice": {
                            "Discount": 100,
                            "DiscountPrice": 90,
                            "OriginalBundlePrice": 90,
                            "OriginalPrice": 90
                        }
                    },
                    "SupportLinuxUnixPlatform": true,
                    "SupportWindowsPlatform": true,
                    "SystemDiskSize": 40,
                    "SystemDiskType": "CLOUD_SSD"
                },
                "ModifyBundleState": "UNAVAILABLE",
                "NotSupportModifyMessage": "",
                "ModifyPrice": {
                    "InstancePrice": {
                        "Discount": 100,
                        "DiscountPrice": 19.73,
                        "OriginalBundlePrice": 90,
                        "OriginalPrice": 19.73
                    }
                }
            },
            {
                "Bundle": {
                    "BundleDisplayLabel": "NORMAL",
                    "BundleId": "bundle_ntp_small1_500",
                    "BundleSalesState": "AVAILABLE",
                    "BundleType": "GENERAL_BUNDLE",
                    "CPU": 1,
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 3,
                    "Memory": 1,
                    "MonthlyTraffic": 500,
                    "Price": {
                        "InstancePrice": {
                            "Discount": 100,
                            "DiscountPrice": 90,
                            "OriginalBundlePrice": 90,
                            "OriginalPrice": 90
                        }
                    },
                    "SupportLinuxUnixPlatform": true,
                    "SupportWindowsPlatform": true,
                    "SystemDiskSize": 40,
                    "SystemDiskType": "CLOUD_SSD"
                },
                "ModifyBundleState": "UNAVAILABLE",
                "NotSupportModifyMessage": "",
                "ModifyPrice": {
                    "InstancePrice": {
                        "Discount": 100,
                        "DiscountPrice": 19.73,
                        "OriginalBundlePrice": 90,
                        "OriginalPrice": 19.73
                    }
                }
            },
            {
                "Bundle": {
                    "BundleDisplayLabel": "NORMAL",
                    "BundleId": "bundle_ntp_small2_1000",
                    "BundleSalesState": "AVAILABLE",
                    "BundleType": "GENERAL_BUNDLE",
                    "CPU": 1,
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 5,
                    "Memory": 2,
                    "MonthlyTraffic": 1000,
                    "Price": {
                        "InstancePrice": {
                            "Discount": 100,
                            "DiscountPrice": 140,
                            "OriginalBundlePrice": 140,
                            "OriginalPrice": 140
                        }
                    },
                    "SupportLinuxUnixPlatform": true,
                    "SupportWindowsPlatform": true,
                    "SystemDiskSize": 40,
                    "SystemDiskType": "CLOUD_SSD"
                },
                "ModifyBundleState": "UNAVAILABLE",
                "NotSupportModifyMessage": "",
                "ModifyPrice": {
                    "InstancePrice": {
                        "Discount": 100,
                        "DiscountPrice": 52.6,
                        "OriginalBundlePrice": 140,
                        "OriginalPrice": 52.6
                    }
                }
            }
        ],
        "RequestId": "f1bb6c99-e704-441e-a405-a594cb55c989",
        "TotalCount": 3
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.DescribeInstanceStatus An error occurred when querying the instance status.
    FailedOperation.DescribeInstancesModificationError Failed to query the instance configuration adjustment.
    FailedOperation.RequestError A request error occurred.
    FailedOperation.TradeGetPriceFailed Failed to query the price.
    InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
    InternalError.DescribeInstancesModification Failed to query whether the configuration of the instance can be modified.
    InternalError.DescribeInstancesModificationError Failed to query whether the configuration of the instance can be modified.
    InternalError.InvalidBundlePrice The package price is incorrect.
    InternalError.InvalidCommandNotFound The command is not found.
    InternalError.RequestError There was an error in the request.
    InternalError.TradeGetPriceFailed Failed to get the price.
    InvalidParameter.BundleIdNotFound Undefined service package ID.
    InvalidParameter.FilterValueLimitExceeded Invalid parameter: the number of Values in the Filter parameter exceeds the allowed maximum number.
    InvalidParameter.InvalidFilter Invalid parameter: the Filter parameter is invalid.
    InvalidParameter.InvalidFilterInvalidKey Invalid parameter: the value of Name in the Filter parameter is invalid.
    InvalidParameter.InvalidFilterInvalidNameNotStr Invalid parameter: the value of Name in the Filter parameter is not a string.
    InvalidParameter.InvalidFilterNotDict Invalid parameter: the Filter parameter is not a dictionary.
    InvalidParameter.InvalidFilterNotSupportedName Invalid parameter: there are unsupported Name values in the Filter parameter.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    InvalidParameterValue.InvalidBlueprintPlatformType The type of the image OS is invalid.
    InvalidParameterValue.InvalidConsoleDisplayTypes The console display type is invalid.
    InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
    InvalidParameterValue.Negative Invalid parametric value: it cannot be negative.
    InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
    OperationDenied.BundleNotSupportModify This instance does not support upgrading packages.
    ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
    UnauthorizedOperation.NoPermission No permission
    UnsupportedOperation.InstanceExpired Unsupported operation: the instance has expired.
    UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy