tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateProject

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

    1. API Description

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

    This API is used to create a RUM application which belongs to a specific team.

    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: CreateProject.
    Version Yes String Common Params. The value used for this API: 2021-06-22.
    Region No String Common Params. This parameter is not required.
    Name Yes String Name of the created project (required and up to 200 characters)
    InstanceID Yes String Business system ID
    Rate Yes String Project sampling rate (greater than or equal to 0)
    EnableURLGroup Yes Integer Whether to enable aggregation
    Type Yes String Project type (valid values: "web", "mp", "android", "ios", "node", "hippy", "weex", "viola", "rn")
    Repo No String Repository address of the project (optional and up to 256 characters)
    URL No String Webpage address of the project (optional and up to 256 characters)
    Desc No String Description of the created project (optional and up to 1,000 characters)

    3. Output Parameters

    Parameter Name Type Description
    ID Integer Project ID
    Key String Unique project key
    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 Creating a RUM application

    This example shows you how to create a RUM application.

    Input Example

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

{
    "Name": "'Test project'",
    "InstanceID": "\"taw-123\"",
    "Repo": "'http://github.com/xxx'",
    "URL": "'http://www.qq.com'",
    "Rate": "\"10\"",
    "EnableURLGroup": "1",
    "Type": "web",
    "Desc": "'Project description'"
}

    Output Example

    {
    "Response": {
        "ID": 1,
        "Key": "RlOmCVbPrKd4",
        "RequestId": "65a8fec7-2b39-4b11-893f-3715279d235f"
    }
}

    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.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    MissingParameter Missing parameter.
    ResourceInsufficient Insufficient resource.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy