tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeProject

Last updated: 2024-06-21 15:10:37

1. API Description

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

Retrieving Project 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: DescribeProject.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ProjectId No String Project ID. It is common to use the Project ID for queries, and either this or projectName must be present.
DescribeClusters No Boolean Whether to Display Associated Cluster Information
DescribeExecutors No Boolean Whether to Display Information of Associated Execution Group, only partial information.
DescribeAdminUsers No Boolean Default not to display project administrator information
DescribeMemberCount No Boolean Default not to count the number of project personnel
DescribeCreator No Boolean Default not to query creator's information
ProjectName No String The project name is unique within a tenant, generally used for conversion to Project ID.

3. Output Parameters

Parameter Name Type Description
Data Project Project Information
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 describe project with params

Input Example

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

{
    "ProjectId": "9782035857154610592"
}

Output Example

{
    "Response": {
        "Data": {
            "TenantId": "abc",
            "ProjectId": "abc",
            "ProjectName": "abc",
            "DisplayName": "abc",
            "Region": "abc",
            "Description": "abc",
            "CreateTime": "2020-09-22T00:00:00+00:00",
            "Creator": {
                "UserId": "abc",
                "UserName": "abc",
                "DisplayName": "abc",
                "PhoneNum": "abc",
                "Email": "abc"
            },
            "Tenant": {
                "TenantId": "abc",
                "TenantName": "abc",
                "DisplayName": "abc",
                "Description": "abc",
                "OwnerUserId": "abc",
                "Params": "abc"
            },
            "AdminUsers": [
                {
                    "UserId": "abc",
                    "UserName": "abc",
                    "DisplayName": "abc",
                    "PhoneNum": "abc",
                    "Email": "abc"
                }
            ],
            "Clusters": [
                {
                    "ClusterId": "abc",
                    "ClusterType": "abc",
                    "ClusterName": "abc",
                    "RegionCn": "abc",
                    "RegionEn": "abc",
                    "RegionArea": "abc",
                    "Used": true,
                    "Status": 1,
                    "StatusInfo": "abc",
                    "StorageType": "abc",
                    "ComputeType": "abc",
                    "ClusterResource": "abc",
                    "ChargeType": "abc",
                    "CreateTime": "2020-09-22T00:00:00+00:00",
                    "ExtraConf": "abc",
                    "RangerUserName": "abc",
                    "CdwUserName": "abc"
                }
            ],
            "Params": "abc",
            "Status": 1,
            "Model": "abc"
        },
        "RequestId": "abc"
    }
}

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 Failure.
InvalidParameter.WorkspaceNotExist Workspace does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy