tencent cloud

Feedback

DescribeDataCustomUrl

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

    1. API Description

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

    This API is used to get the DescribeDataCustomUrl information.

    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: DescribeDataCustomUrl.
    Version Yes String Common Params. The value used for this API: 2021-06-22.
    Region No String Common Params. This parameter is not required.
    StartTime Yes Integer Start time
    Type Yes String top: top resources view; allcount: performance view; day: 14-day data; condition: condition list; pagepv: PV view; area: request speed distribution; nettype/version/platform/isp/region/device/browser/ext1/ext2/ext3/ret/status/from/url/env: network/platform view; version view; device view; ISP view; region view; browser view; custom view, and so on.
    EndTime Yes Integer End time
    ID Yes Integer Project ID
    ExtSecond No String Custom 2
    Engine No String Browser engine
    Isp No String ISP
    From No String Source page
    Level No String Log level
    Brand No String Brand
    Area No String Region
    VersionNum No String Version
    Platform No String Platform
    ExtThird No String Custom 3
    ExtFirst No String Custom 1
    NetType No String Network type
    Device No String Model
    IsAbroad No String Whether it is outside the Chinese mainland
    Os No String OS
    Browser No String Browser
    CostType No String Duration calculation method
    Url No String Key value of the custom speed test
    Env No String Environment

    3. Output Parameters

    Parameter Name Type Description
    Result String Returned value
    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 Getting DescribeDataCustomUrl information

    Input Example

    https://rum.intl.tencentcloudapi.com/?Action=DescribeDataCustomUrl
    &ID=1
    &StartTime=1625444040
    &EndTime=1625454840
    &Type=pagepv
    &Level=1
    &Isp=China Mobile
    &Area=China
    &NetType=2
    &Platform=2
    &Device=Samsung
    &VersionNum=Version
    &ExtFirst=Custom 1
    &ExtSecond=Custom 2
    &ExtThird=Custom 3
    &IsAbroad=1
    &Browser=ie
    &Os=apple
    &Engine=ie2
    &Brand=apple
    &From=index.html
    &CostType=avg
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "Result": "xxxx",
            "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.
    DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
    FailedOperation Operation failed.
    FailedOperation.ClsCallFail CLS call failed.
    FailedOperation.DataBaseException Exceptional data operation.
    FailedOperation.InfrastructureError Exceptional third-party dependency.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Missing parameter.
    OperationDenied The operation was denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    ResourceInUse The resource is in use.
    ResourceInsufficient Insufficient resource.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.NoInstance The instance does not exist.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.