All Products
Search

This Product

    SetRenewal

    Document Center

    SetRenewal

    Last Updated: Oct 17, 2018

    API Name

    SetRenewal

    Overview

    You can call this operation to set auto renewal for a specified instance.

    Request parameters

    Name Type Required Description
    OwnerId Long No The ID of the owner, which is a 16-digit number.
    ProductCode String Yes The code of the specified product.
    ProductType String No The type of the specified product.
    RenewalStatus String Yes The renewal status of the specified instance. Valid values: AutoRenewal – auto renewal, ManualRenewal – manual renewal, NotRenewal – no renewal
    InstanceIDs String Yes The ID of the specified instance. You can set a maximum of 100 subscription instances. The identifiers of multiple instances are separated with commas (,).
    RenewalPeriod Integer No The renewal period of the specified instance. Valid values: 1，2，3，6，12. This parameter is required when RenewalStatus is set to AutoRenewal.
    RenewalPeriodUnit String No The unit of the renewal period. Valid values: M-months and Y-years, This parameter is required when RenewalStatus is set to AutoRenewal.

    Response parameters

    Name Type Description
    Success Boolean Indicates whether the call is successful.
    Code String The error code of a failed call.
    Message String The details of the response.
    RequestId String The GUID generated by Alibaba Cloud for the request.

    Error codes

    Error code Description HTTP status code Description
    NotApplicable This API is not applicable for caller. 400 The error message returned when you are not authorized to use the API.
    MissingParameter The specified parameter xx is mandatory for this request. 400 The error message returned when the xx parameter is not specified.
    InvalidParameter The specified parameter xx is not valid. 400 The error message returned when the xx parameter is invalid.
    InvalidModuleCode The specified moduleCode is not valid. 400 The error message returned when the specified moduleCode parameter is invalid.
    InvalidConfigCode The specified configCode is not valid. 400 The error message returned when the specified configCode parameter is invalid.
    InvalidOwner The specified owner doesn’t belong to caller. 400 The error message returned when the specified owner does not belong to the caller.
    InvalidCaller The specified caller doesn’t exists. 400 The error message returned when the caller is invalid.
    InternalError The request processing has failed due to some unknown error, exception or failure. 400 The error message returned when an unknown internal error occurs.
    ProductNotFind Can not find inquired product, it may not exist. 400 The error message returned when the specified product is invalid.

    Sample requests

    Sample responses