Back to Apitable

.InternalServiceSpaceInterfaceApi

packages/api-client/InternalServiceSpaceInterfaceApi.md

1.13.0-beta.113.3 KB
Original Source

.InternalServiceSpaceInterfaceApi

All URIs are relative to http://backend/api/v1

MethodHTTP requestDescription
apiRateLimitGET /internal/space/{spaceId}/apiRateLimitget api qps information of a specified space
apiUsagesGET /internal/space/{spaceId}/apiUsagesget api usage information of a specified space
getAutomationRunMessageGET /internal/space/{spaceId}/automation/run/messageget space automation run message
getCreditUsages1GET /internal/space/{spaceId}/credit/usagesget space credit used usage
getSpaceCapacityGET /internal/space/{spaceId}/capacityget attachment capacity information for a space
getSpaceSubscriptionGET /internal/space/{spaceId}/subscriptionget subscription information for a space
getSpaceUsagesGET /internal/space/{spaceId}/usagesget space used usage information
labsGET /internal/space/{spaceId}get space information
statisticsPOST /internal/space/{spaceId}/statisticsget space information

apiRateLimit

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.

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]defaults to undefined

Return type

ResponseDataInternalSpaceApiRateLimitVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiUsages

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.

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]defaults to undefined

Return type

ResponseDataInternalSpaceApiUsageVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAutomationRunMessage

ResponseDataInternalSpaceAutomationRunMessageV0 getAutomationRunMessage()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataInternalSpaceAutomationRunMessageV0

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCreditUsages1

ResponseDataInternalCreditUsageVo getCreditUsages1()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataInternalCreditUsageVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSpaceCapacity

ResponseDataInternalSpaceCapacityVo getSpaceCapacity()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataInternalSpaceCapacityVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSpaceSubscription

ResponseDataInternalSpaceSubscriptionVo getSpaceSubscription()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataInternalSpaceSubscriptionVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSpaceUsages

ResponseDataInternalSpaceUsageVo getSpaceUsages()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined

Return type

ResponseDataInternalSpaceUsageVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

labs

ResponseDataInternalSpaceInfoVo labs()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceId[string]defaults to undefined

Return type

ResponseDataInternalSpaceInfoVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

statistics

ResponseDataVoid statistics(spaceStatisticsRo, )

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
spaceStatisticsRoSpaceStatisticsRo
spaceId[string]defaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]