Skip to Content

list apikeys - ListUMInferAPIKey

Overview

List Query apikey

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListUMInferAPIKey.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the GetProjectList APIYes
OffsetintStarting position offset of the list, default is 0No
LimitintThe length of the returned data, default is 20, maximum is 100No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
Dataarray[APIKey]apikeyYes

Data Model

APIKey

Field NameTypeDescription InformationRequired
KeyIdstringResource IDNo
NamestringNameNo
ChannelIdintchannel idNo
TopOrganizationIdintcompany idNo
OrganizationIdintorganization idNo
StatusintStatus, 1 NormalNo
CreateTimeintCreation TimeNo
KeystringKey ValueNo
ExpireTimeintUnix timestamp of expiration time, -1 means no expirationNo
GrantedModelsstringAuthorized models, separated by commas, ‘all’ indicates all models have permissionNo

Example

Request Example

https://api.surfercloud.com/?Action=ListUMInferAPIKey &Offset=7 &Limit=5 &ProjectId=BwpkilUS

Response Example

{ "Action": "ListUMInferAPIKeyResponse", "Data": {}, "RetCode": 0 }