Obtain Authentication Information via Interface (Non-standard Usage) - GetAuthConfig
Overview
Obtaining authentication information through the interface (non-standard usage)
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetAuthConfig . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | 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 |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
Zone | string | Availability Zone. See Availability Zone List | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
Domain | string | Desired domain name, if not passed, all will be obtained | 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 |
AuthConfigs | array[KwaiDomainAuthConfig] | Authentication Configuration List | No |
Data Model
KwaiDomainAuthConfig
Field Name | Type | Description Information | Required |
---|---|---|---|
Domain | string | Domain Name | Yes |
Config | array[KwaiAuthConfig] | Yes |
KwaiAuthConfig
Field Name | Type | Description Information | Required |
---|---|---|---|
Type | string | Type pkey / ksc / typeA | Yes |
Keys | array[KwaiAuthKv] | No |
KwaiAuthKv
Field Name | Type | Description Information | Required |
---|---|---|---|
Key | string | Key Information | Yes |
Iv | string | The translation for 'iv信息' is not provided in the given examples. Could you please provide more context or a specific translation for this term? | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=GetAuthConfig
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=DFzPRVqI
&Domain=HhTjSARl
Response Example
{
"Action": "GetAuthConfigResponse",
"AuthConfigs": [
{
"Config": [
{
"Keys": [
{
"Iv": "222",
"Key": "111"
}
],
"Type": "pkey"
},
{
"Keys": [
{
"Iv": "444",
"Key": "333"
},
{
"Iv": "666",
"Key": "555"
}
],
"Type": "ksc"
}
],
"Domain": "www.xx.com"
}
],
"RetCode": 0
}