1. Interface Description
Interface request domain name: tpo.api3.convergecloud.com.
API for querying a project resource list
Default interface request rate limit: 20 times per second.
Interface update time: 2023-10-13 11:18:22.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeProjectResources |
| Version | Yes | No | String | Public parameter, The value of this interface: 2020-09-20 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| ProjectId | Yes | No | String | Project ID Example: pr-dcd34c11 |
| PageNumber | No | No | Uint64 | Page number. Example: 100 |
| PageSize | No | No | Uint64 | Number of entries per page. Example: 100 |
| Filter | No | No | ProjectResourceFilter | Search conditions Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Uint64 | Total. Example: 100 |
| ResourceSet | Array of ProjectResource | Resource list Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InternalError.ThirdPartServiceBadRequest | Failed to call the service. |
| InternalError.ComponentFail | Failed to call an API of other components. |
| InternalError.InvalidHTTPCode | Invalid HTTP code. |
| ResourceNotFound.ProjectNotFoundError | The project does not exist. |
| InternalError.DatabaseError | Internal database error. |
| UnauthorizedOperation.AuthFailedError | Authentication failed. |