list apikeys - ListUMInferAPIKey
Overview
List Query apikey
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListUMInferAPIKey . | Yes |
PublicKey | string | The user’s public key can be obtained from Console  | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
ProjectId | string | Project ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the GetProjectList API | Yes |
Offset | int | Starting position offset of the list, default is 0 | No |
Limit | int | The length of the returned data, default is 20, maximum is 100 | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Data | array[APIKey] | apikey | Yes |
Data Model
APIKey
Field Name | Type | Description Information | Required |
---|---|---|---|
KeyId | string | Resource ID | No |
Name | string | Name | No |
ChannelId | int | channel id | No |
TopOrganizationId | int | company id | No |
OrganizationId | int | organization id | No |
Status | int | Status, 1 Normal | No |
CreateTime | int | Creation Time | No |
Key | string | Key Value | No |
ExpireTime | int | Unix timestamp of expiration time, -1 means no expiration | No |
GrantedModels | string | Authorized models, separated by commas, ‘all’ indicates all models have permission | No |
Example
Request Example
https://api.surfercloud.com/?Action=ListUMInferAPIKey
&Offset=7
&Limit=5
&ProjectId=BwpkilUS
Response Example
{
"Action": "ListUMInferAPIKeyResponse",
"Data": {},
"RetCode": 0
}