Modify Auto-Renewal Tag for Resources - ModifyAutoRenewFlag
Overview
Modify Auto-Renewal Tag for Resources
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ModifyAutoRenewFlag . | 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 |
---|---|---|---|
Flag | string | Switch Identifier (TURN_ON: On; TURN_OFF: Off) | Yes |
ResourceId | string | Resource ID | Yes |
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 |
Success | int | Number of Successful Operations | Yes |
Fail | int | Operation Failed Resource Quantity | Yes |
ResultSet | array[ResultSet] | Switch resource auto-renewal result array | Yes |
Data Model
ResultSet
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Renewal Result (0: Success, Failure Returns Error Code) | No |
Message | string | Error Message Description | No |
ResourceId | string | Resource ID | No |
Example
Request Example
https://api.surfercloud.com/?Action=ModifyAutoRenewFlag
&Flag=TURN_ON
&ResourceId=PDSrpaDZ
Response Example
{
"Action": "ModifyAutoRenewFlagResponse",
"Fail": 1,
"ResultSet": [
{
"Message": "",
"ResourceId": "HHBMiHoq1",
"RetCode": 0
},
{
"Message": "fYUXfpKn",
"ResourceId": "HHBMiHoq2",
"RetCode": 5
}
],
"RetCode": 0,
"Success": 1
}