tencent cloud

Feedback

CreateTawInstance

Last updated: 2024-11-26 17:16:41

    1. API Description

    Domain name for API request: rum.intl.tencentcloudapi.com.

    This API is used to create a RUM business system.

    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: CreateTawInstance.
    Version Yes String Common Params. The value used for this API: 2021-06-22.
    Region No String Common Params. This parameter is not required.
    AreaId Yes Integer Region ID (at least greater than 0)
    ChargeType Yes Integer Billing type (1: Pay-as-you-go).
    DataRetentionDays Yes Integer Data retention period (at least greater than 0)
    InstanceName Yes String Instance name (up to 255 bytes)
    Tags.N No Array of Tag Tag list
    InstanceDesc No String Instance description (up to 1,024 bytes)
    CountNum No String Number of data entries reported per day
    PeriodRetain No String Billing for data storage
    BuyingChannel No String Instance purchase channel. Valid value: cdn.
    ResourcePackageType No Integer Type of prepaid resource pack (only required for prepaid mode)
    ResourcePackageNum No Integer The number of prepaid resource packs (only required for prepaid mode)
    InstanceType No Integer Instance type. 1: Web; 2: Application

    3. Output Parameters

    Parameter Name Type Description
    InstanceId String Instance ID
    DealName String ID of prepaid order
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying an instance

    This example shows you how to create an instance.

    Input Example

    POST / HTTP/1.1Host: rum.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateTawInstance<Common request parameters>{    "AreaId": 1,    "InstanceName": "test",    "ChargeType": 1,    "DataRetentionDays": 30,    "InstanceDesc": "test"}
    

    Output Example

    {
        "Response": {
            "InstanceId": "taw-4vVPH0Jn",
            "DealName": "",
            "RequestId": "57f4d8a2-13b6-4ac0-9f0b-0acc7bbc1d61"
        }
    }
    

    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
    AuthFailure Error with CAM signature/authentication.
    FailedOperation Operation failed.
    FailedOperation.ChargeNoBalance Billing - The account balance is insufficient.
    FailedOperation.ChargeNoPayRight Billing - The account doesn’t have the payment permission.
    FailedOperation.ChargeParamInvalid Billing - Invalid billing parameters.
    FailedOperation.InfrastructureError Exceptional third-party dependency.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    ResourceNotFound The resource does not exist.