You need to enable JavaScript to run this app.
Torch Log Service

Torch Log Service

Copy page
Download PDF
Project management API
DescribeProject
Copy page
Download PDF
DescribeProject
Call the DescribeProject interface to query the information of the specified project.​
Usage notes​
The call frequency limit for this interface is 20 times/s, and exceeding the frequency limit will result in an ExceedQPSLimit error.​
Request syntax​
  • Request Method:GET​
  • Request URL:https://{tls-endpoint}/DescribeProject​
Request parameters​
The table below only lists the request parameters specific to this interface and some common parameters. For more information, please see Common parameters.​
Query​
​
Name​
Type​
Required​
Example​
Description​
ProjectId​
String​
True​
f3e901c3-b17f-42fd-aa8c-dc91a6c7****​
The ID of the project.​
​
Responses​
The table below only lists the return parameters specific to this interface. For more information, please refer to the Response message.​
​
Name​
Type​
Example​
Description​
ProjectName​
String​
test-project​
The name of the project.​
ProjectId​
String​
F ********​
The ID of the project.​
Description​
String​
This is a test project.​
The descriptive information of the project.​
CreateTime​
String​
2021-08-19 11:41:29​
The creation time of the project.​
InnerNetDomain​
String​
tls-example.com​
The private network connection domain name.​
TopicCount​
Integer​
5​
The number of the topics under the project.​
IamProjectName​
String​
Default​
The IAM project to which the project belongs.​
Tags​
Array of Tag​
[{"Key": "key1", "Value": "value1"}]​
The topic tag information.​
​
Tag​
​
Name​
Type​
Example​
Description​
Key​
String​
owner​
The key of the tag. For setting rules, please refer to Tag Setting Rules.​
Value​
String​
zhangsan​
The value of the tag. For setting rules, please refer to Tag Setting Rules.​
​
Sample Request​
​
GET https://{tls-endpoint}/DescribeProject?ProjectId=f3********* HTTP/1.1​
​
Sample Response​
​
HTTP/1.1 200 OK​
Content-Type: application/json; charset=utf-8​
{​
"ProjectId": "f3************",​
"ProjectName": "test1",​
"Description": "test1",​
"CreateTime": "2022-02-14 20:59:21",​
"TopicCount": 0,​
"InnerNetDomain": "tls-example.com",​
"IamProjectName": "default",​
"Tags": [​
{​
"Key": "key1",​
"Value": "value1"​
}​
]​
}​
​
Error code​
The table below only lists the return parameters specific to this interface. For more information, please refer to the Common error codes.​
​
HTTP status code​
Error code​
Error message​
Description​
400​
InvalidArgument​
Invalid argument key %s, value %s, please check argument.​
Invalid request parameter.​
404​
ErrProjectNotExists​
Project does not exist.​
The project does not exist.​
500​
InternalServerError​
We encountered an unexpected server error, please try again later.​
Internal server error.​
​
​
​
Last updated: 2025.10.28 18:41:13