Domain name for API request: wedata.tencentcloudapi.com.
Retrieving Project Information
A maximum of 20 requests can be initiated per second for this API.
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. |
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. |
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProject
<Common request parameters>
{
"ProjectId": "9782035857154610592"
}
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?