Controlling an Asset Transfer Task
Function
Controls an asset transfer task.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
URI
POST /v1/{project_id}/digital-assets-action/transfers/{job_id}/{action}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
|
job_id |
Yes |
String |
Task ID |
|
action |
Yes |
String |
Asset transfer control. cancel: Canceling an asset transfer task. This API can only be called by the transfer initiator. accept: Accepting an asset transfer task. This API can only be called by the transfer receiver. accept_confirm: Confirming the acceptance of an asset transfer task. This API can only be called by the transfer receiver. Asset transfers need to be confirmed again only when billing is involved. reject: Rejecting the asset transfer. This API can only be called by the transfer receiver. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-App-UserId |
No |
String |
Third-party user ID, which does not allow Chinese characters. |
|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
|
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
reason |
No |
String |
Rejection reason |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-Request-Id |
String |
Request ID |
|
Parameter |
Type |
Description |
|---|---|---|
|
accept_respone |
TransAcceptResponse object |
|
Parameter |
Type |
Description |
|---|---|---|
|
is_need_billing |
Boolean |
Whether to deduct resources from the recipient during asset transfer (generating charging CDRs) Default value: false |
|
required_resources |
Array of BillResources objects |
Resources to be deducted. |
|
Parameter |
Type |
Description |
|---|---|---|
|
resource_type |
String |
Resource type. Options: Supported image resource types:
Supported voice resource types:
|
|
resource_nums |
Integer |
Resource quantity. Value range: 0~1000000 |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Example Requests
POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/digital-assets/transfers/b2f8a9e9c39b6dc7ed4c0cfd67366c6a/confirm
Example Responses
Status code: 400
Parameters error, including the error code and its description.
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Succeeded |
|
400 |
Parameters error, including the error code and its description. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot