1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
Edit Order
Default interface request rate limit: 20 times per second.
Interface update time: 0001-01-01 00:00:00.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyOrder |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-02-28 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| Data | No | No | Array of OrderData | Order configuration array, with a maximum length of 10. New purchase and configuration adjustment are not allowed to occur at the same time. Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| BigDealId | String | Main order number, which is not returned for pay-as-you-go orders. Example: any data |
| DealNames | Array of String | Sub-order number Example: ["32454"] |
| ResourceIds | Array of String | Resource ID. For postpaid orders, it will be returned. For prepaid (monthly subscription) orders, payment needs to be made first by calling the fee payment API via the large order number or sub-order number. Example: ["32454"] |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter | Invalid parameter. |
| OperationDenied | Operation denied. |
| InvalidParameterValue | The parameter value is invalid. |