tencent cloud

文档反馈

InquiryPriceCreateInstance

最后更新时间:2024-01-09 10:47:33

    1. API Description

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

    This API is used to query price of instance creation.

    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: InquiryPriceCreateInstance.
    Version Yes String Common Params. The value used for this API: 2019-01-03.
    Region No String Common Params. This parameter is not required for this API.
    TimeUnit Yes String Time unit of instance purchase duration. Valid values:
  • s: seconds. When PayMode is 0, TimeUnit can only be s.
  • TimeSpan Yes Integer Purchase duration of instance, which needs to be used together with TimeUnit.
  • When TimeUnit is s, this parameter can only be filled with 3600, indicating a pay-as-you-go instance.
  • When TimeUnit is m, the number entered in this parameter indicates the purchase duration of the monthly-subscription instance; for example, 1 means one month
  • Currency Yes String Currency.
    PayMode Yes Integer Instance billing mode. Valid values:
  • 0: pay-as-you-go.
  • SupportHA Yes Integer Whether to enable high availability of node. Valid values:
  • 0: does not enable high availability of node.
  • 1: enables high availability of node.
  • Software.N Yes Array of String List of deployed components. Different required components need to be selected for different EMR product IDs (i.e., ProductId; for specific meanings, please see the ProductId field in the input parameter):
  • When ProductId is 1, the required components include hadoop-2.7.3, knox-1.2.0, and zookeeper-3.4.9
  • When ProductId is 2, the required components include hadoop-2.7.3, knox-1.2.0, and zookeeper-3.4.9
  • When ProductId is 4, the required components include hadoop-2.8.4, knox-1.2.0, and zookeeper-3.4.9
  • When ProductId is 7, the required components include hadoop-3.1.2, knox-1.2.0, and zookeeper-3.4.9
  • ResourceSpec No NewResourceSpec Node specification queried for price.
    Placement No Placement Instance location. This parameter is used to specify the AZ, project, and other attributes of the instance.
    VPCSettings No VPCSettings Configuration information of VPC. This parameter is used to specify the VPC ID, subnet ID, etc.
    MetaType No String Hive-shared metadatabase type. Valid values:
  • EMR_DEFAULT_META: the cluster creates one by default.
  • EMR_EXIST_META: the cluster uses the specified EMR-MetaDB instance.
  • USER_CUSTOM_META: the cluster uses a custom MetaDB instance.
  • UnifyMetaInstanceId No String EMR-MetaDB instance
    MetaDBInfo No CustomMetaInfo Custom MetaDB instance information
    ProductId No Integer Product ID. Different product IDs represent different EMR product versions. Valid values:
  • 1: EMR v1.3.1.
  • 2: EMR v2.0.1.
  • 4: EMR v2.1.0.
  • 7: EMR v3.0.0.
  • SceneName No String Scenario-based values:
    Hadoop-Kudu
    Hadoop-Zookeeper
    Hadoop-Presto
    Hadoop-Hbase
    ExternalService.N No Array of ExternalService Shared component information
    VersionID No Integer
    MultiZoneSettings.N No Array of MultiZoneSetting AZ specs

    3. Output Parameters

    Parameter Name Type Description
    OriginalCost Float Original price.
    Note: this field may return null, indicating that no valid values can be obtained.
    DiscountCost Float Discounted price.
    Note: this field may return null, indicating that no valid values can be obtained.
    TimeUnit String Time unit of instance purchase duration. Valid values:
  • s: seconds.

  • Note: this field may return null, indicating that no valid values can be obtained.
    TimeSpan Integer Purchase duration of instance.
    Note: this field may return null, indicating that no valid values can be obtained.
    PriceList Array of ZoneDetailPriceResult The price list.
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the price of creating an instance

    Input Example

    POST / HTTP/1.1
    Host: emr.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: InquiryPriceCreateInstance
    <Common request parameters>
    
    {
        "ResourceSpec": {
            "MasterResourceSpec": {
                "StorageType": "5",
                "DiskType": "CLOUD_PREMIUM",
                "Cpu": "4",
                "DiskSize": "100",
                "MemSize": "16384",
                "RootSize": "100",
                "Spec": "CVM.S3"
            },
            "CoreCount": "2",
            "CoreResourceSpec": {
                "StorageType": "5",
                "DiskType": "CLOUD_PREMIUM",
                "Cpu": "4",
                "DiskSize": "100",
                "MemSize": "16384",
                "RootSize": "100",
                "Spec": "CVM.S3"
            },
            "MasterCount": "1"
        },
        "Placement": {
            "ProjectId": "0",
            "Zone": "ap-guangzhou-3"
        },
        "SupportHA": "0",
        "TimeSpan": "3600",
        "VPCSettings": {
            "SubnetId": "subnet-jhgsahx0",
            "VpcId": "vpc-ezt5qmqz"
        },
        "PayMode": "0",
        "Currency": "USD",
        "TimeUnit": "s",
        "ProductId": "2",
        "Software": [
            "zookeeper-3.4.9",
            "hadoop-2.7.3",
            "knox-1.2.0",
            "hive-2.3.2"
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "f329b63c-7cec-41f3-91ae-500cbf86b9eb",
            "TimeSpan": 3600,
            "TimeUnit": "s",
            "DiscountCost": 25,
            "OriginalCost": 25,
            "PriceList": [
                {
                    "NodeDetailPrice": [
                        {
                            "NodeType": "task",
                            "PartDetailPrice": [
                                {
                                    "GoodsNum": 1,
                                    "InstanceType": "rootDisk",
                                    "Policy": 10,
                                    "Price": 0.12,
                                    "RealCost": 0.12,
                                    "RealTotalCost": 0.12
                                },
                                {
                                    "GoodsNum": 1,
                                    "InstanceType": "node",
                                    "Policy": 10,
                                    "Price": 2.16,
                                    "RealCost": 2.16,
                                    "RealTotalCost": 2.16
                                },
                                {
                                    "GoodsNum": 1,
                                    "InstanceType": "dataDisk",
                                    "Policy": 10,
                                    "Price": 0.5,
                                    "RealCost": 0.5,
                                    "RealTotalCost": 0.5
                                }
                            ]
                        },
                        {
                            "NodeType": "master",
                            "PartDetailPrice": [
                                {
                                    "GoodsNum": 2,
                                    "InstanceType": "rootDisk",
                                    "Policy": 10,
                                    "Price": 0.12,
                                    "RealCost": 0.12,
                                    "RealTotalCost": 0.25
                                },
                                {
                                    "GoodsNum": 2,
                                    "InstanceType": "node",
                                    "Policy": 10,
                                    "Price": 2.16,
                                    "RealCost": 2.16,
                                    "RealTotalCost": 4.31
                                },
                                {
                                    "GoodsNum": 2,
                                    "InstanceType": "dataDisk",
                                    "Policy": 10,
                                    "Price": 0.5,
                                    "RealCost": 0.5,
                                    "RealTotalCost": 1
                                }
                            ]
                        },
                        {
                            "NodeType": "core",
                            "PartDetailPrice": [
                                {
                                    "GoodsNum": 3,
                                    "InstanceType": "rootDisk",
                                    "Policy": 10,
                                    "Price": 0.12,
                                    "RealCost": 0.12,
                                    "RealTotalCost": 0.37
                                },
                                {
                                    "GoodsNum": 3,
                                    "InstanceType": "node",
                                    "Policy": 10,
                                    "Price": 2.15,
                                    "RealCost": 2.15,
                                    "RealTotalCost": 6.46
                                },
                                {
                                    "GoodsNum": 3,
                                    "InstanceType": "dataDisk",
                                    "Policy": 10,
                                    "Price": 0.5,
                                    "RealCost": 0.5,
                                    "RealTotalCost": 1.5
                                }
                            ]
                        },
                        {
                            "NodeType": "common",
                            "PartDetailPrice": [
                                {
                                    "GoodsNum": 3,
                                    "InstanceType": "rootDisk",
                                    "Policy": 10,
                                    "Price": 0.12,
                                    "RealCost": 0.12,
                                    "RealTotalCost": 0.37
                                },
                                {
                                    "GoodsNum": 3,
                                    "InstanceType": "node",
                                    "Policy": 10,
                                    "Price": 2.15,
                                    "RealCost": 2.15,
                                    "RealTotalCost": 6.46
                                },
                                {
                                    "GoodsNum": 3,
                                    "InstanceType": "dataDisk",
                                    "Policy": 10,
                                    "Price": 0.5,
                                    "RealCost": 0.5,
                                    "RealTotalCost": 1.5
                                }
                            ]
                        }
                    ],
                    "ZoneId": "100003"
                }
            ]
        }
    }
    

    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.GetCamServerFailed Failed to call the CAM service.
    FailedOperation.GetTradeServerFailed Failed to call the price inquiry center service.
    InternalError.AccountCgwError An error occurred while calling another service API.
    InternalError.CamCgwError An error occurred while calling another service API.
    InternalError.CamError An error occurred while calling another service API.
    InternalError.CbsCgwError An error occurred while calling another service API.
    InternalError.CbsError An error occurred while calling another service API.
    InternalError.CdbCgwError An error occurred while calling another service API.
    InternalError.CdbError An error occurred while calling another service API.
    InternalError.ConfigCgwError An error occurred while calling another service API.
    InternalError.CvmError An error occurred while calling another service API.
    InternalError.KmsError An error occurred while calling another service API.
    InternalError.ProjectCgwError An error occurred while calling another service API.
    InternalError.SgError An error occurred when calling a security group API.
    InternalError.TagError An error occurred while calling another service API.
    InternalError.TradeCgwError An error occurred while calling another service API.
    InternalError.VpcCgwError An error occurred while calling another service API.
    InternalError.VpcError An error occurred while calling another service API.
    InvalidParameter Invalid parameter.
    InvalidParameter.HALessMasterCount Parameter error.
    InvalidParameter.IncorrectCommonCount The number of common nodes is invalid.
    InvalidParameter.IncorrectMasterCount The number of master nodes is invalid.
    InvalidParameter.InvalidCommonDiskType Invalid parameter.
    InvalidParameter.InvalidCoreCount The number of core nodes is invalid.
    InvalidParameter.InvalidInstanceType Invalid model.
    InvalidParameter.InvalidMasterDiskType Invalid parameter.
    InvalidParameter.InvalidResourceSpec Invalid resource specification.
    InvalidParameter.InvalidSoftWareName The software name is invalid.
    InvalidParameter.InvalidTimeUnit Invalid TimeUnit.
    InvalidParameter.InvalidUnifyMeta Invalid unified metadatabase.
    InvalidParameter.InvalidZone Invalid AZ.
    InvalidParameter.NotContainMustSelectSoftware Invalid parameter. Necessary components are missing.
    InvalidParameter.SoftwareNotInProduct There is an invalid product component.
    InvalidParameterValue Incorrect parameter value.
    MissingParameter Missing parameter.
    ResourceInsufficient.DiskInsufficient The disk specification is insufficient.
    ResourceInsufficient.InstanceInsufficient The node specification is unsupported or has been sold out.
    ResourceNotFound.SubnetNotFound No corresponding subnet found.
    ResourcesSoldOut The resources have been sold out.
    ResourcesSoldOut.CbsSoldOut The CBS resources have been sold out.
    ResourcesSoldOut.CvmSoldOut CVM instances have been sold out.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.