packages/api-client/InternalServiceSpaceInterfaceApi.md
All URIs are relative to http://backend/api/v1
| Method | HTTP request | Description |
|---|---|---|
| apiRateLimit | GET /internal/space/{spaceId}/apiRateLimit | get api qps information of a specified space |
| apiUsages | GET /internal/space/{spaceId}/apiUsages | get api usage information of a specified space |
| getAutomationRunMessage | GET /internal/space/{spaceId}/automation/run/message | get space automation run message |
| getCreditUsages1 | GET /internal/space/{spaceId}/credit/usages | get space credit used usage |
| getSpaceCapacity | GET /internal/space/{spaceId}/capacity | get attachment capacity information for a space |
| getSpaceSubscription | GET /internal/space/{spaceId}/subscription | get subscription information for a space |
| getSpaceUsages | GET /internal/space/{spaceId}/usages | get space used usage information |
| labs | GET /internal/space/{spaceId} | get space information |
| statistics | POST /internal/space/{spaceId}/statistics | get space information |
ResponseDataInternalSpaceApiRateLimitVo apiRateLimit()
Provides the authentication function of the middle layer request, and queries the API aps information in the subscription plan corresponding to the space.
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiApiRateLimitRequest = {
// string
spaceId: "spaceId_example",
};
apiInstance.apiRateLimit(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | defaults to undefined |
ResponseDataInternalSpaceApiRateLimitVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataInternalSpaceApiUsageVo apiUsages()
Provides the authentication function of the middle layer request, and queries the API usage information in the subscription plan corresponding to the space.
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiApiUsagesRequest = {
// string
spaceId: "spaceId_example",
};
apiInstance.apiUsages(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | defaults to undefined |
ResponseDataInternalSpaceApiUsageVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataInternalSpaceAutomationRunMessageV0 getAutomationRunMessage()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiGetAutomationRunMessageRequest = {
// string | space id
spaceId: "spczJrh2i3tLW",
};
apiInstance.getAutomationRunMessage(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataInternalSpaceAutomationRunMessageV0
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataInternalCreditUsageVo getCreditUsages1()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiGetCreditUsages1Request = {
// string | space id
spaceId: "spczJrh2i3tLW",
};
apiInstance.getCreditUsages1(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataInternalCreditUsageVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataInternalSpaceCapacityVo getSpaceCapacity()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiGetSpaceCapacityRequest = {
// string | space id
spaceId: "spczJrh2i3tLW",
};
apiInstance.getSpaceCapacity(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataInternalSpaceCapacityVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataInternalSpaceSubscriptionVo getSpaceSubscription()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiGetSpaceSubscriptionRequest = {
// string | space id
spaceId: "spczJrh2i3tLW",
};
apiInstance.getSpaceSubscription(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataInternalSpaceSubscriptionVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataInternalSpaceUsageVo getSpaceUsages()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiGetSpaceUsagesRequest = {
// string | space id
spaceId: "spczJrh2i3tLW",
};
apiInstance.getSpaceUsages(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | space id | defaults to undefined |
ResponseDataInternalSpaceUsageVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataInternalSpaceInfoVo labs()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiLabsRequest = {
// string
spaceId: "spaceId_example",
};
apiInstance.labs(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | defaults to undefined |
ResponseDataInternalSpaceInfoVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid statistics(spaceStatisticsRo, )
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceSpaceInterfaceApi(configuration);
let body:.InternalServiceSpaceInterfaceApiStatisticsRequest = {
// SpaceStatisticsRo
spaceStatisticsRo: {
viewCount: {
"key": 1,
},
recordCount: 111,
},
// string
spaceId: "spaceId_example",
};
apiInstance.statistics(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceStatisticsRo | SpaceStatisticsRo | ||
| spaceId | [string] | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]