All Products
Search
Document Center

BSS OpenAPI:CreateResourcePackage

Last Updated:Mar 01, 2024

Creates a resource plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bssapi:CreateResourcePackageWRITE
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductCodestringYes

The code of the service. You can query the code by calling the QueryProductList operation or viewing Codes of Alibaba Cloud services.

ossbag
PackageTypestringYes

The type of the resource plan. Set this parameter to the code of the resource plan returned by calling the DescribeResourcePackageProduct operation.

FPT_ossbag_absolute_Storage_sh
EffectiveDatestringNo

The time when the resource plan takes effect. If you leave this parameter empty, the resource plan immediately takes effect by default.

Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2020-03-03T12:00:00Z
SpecificationstringYes

The specifications of the resource plan. Set this parameter to the value of the specifications returned by calling the DescribeResourcePackageProduct operation.

40
DurationintegerYes

The validity period of the resource plan.

6
PricingCyclestringNo

The unit of the validity period of the resource plan. Valid values:

  • Month
  • Year

Default value: Month.

Month

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code returned.

Success
Messagestring

The message returned.

Successful!
RequestIdstring

The ID of the request.

6000EE23-274B-4E07-A697-FF2E999520A4
Successboolean

Indicates whether the request is successful.

true
OrderIdlong

The ID of the order.

202407022550621
Dataobject

The data returned.

OrderIdlong

The ID of the order.

202407022550621
InstanceIdstring

The ID of the resource plan.

OSSBAG-cn-****s

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
  "Success": true,
  "OrderId": 202407022550621,
  "Data": {
    "OrderId": 202407022550621,
    "InstanceId": "OSSBAG-cn-****s"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NotApplicableThis API is not applicable for caller.-
400NotAuthorizedThis API is not authorized for caller.-
400MissingParameterAbsent some mandatory parameter for this request.-
400InvalidParameterThis request contain some invalid parameter-
400InvalidOwnerThe specified owner doesn't belong to caller.Invalid user identity.
400DurationInvalidParameter duration can only be positive integer.-
400ProductNotFoundProduct not found.-
400PackageTypeNotFoundNo such resource package type found.-
400SpecificationInvalidParameter specification can only be positive integer.-
400IdInvalidParameter ownerId is invalid.-
400EffectiveDateInvalidParameter effectiveDate is invalid.-
400IdMissingParamter ownerId is missing.-
400PackageTypeNotSupportedPackage type currently is not supported.-
500InternalErrorThe request processing has failed due to some unknown error.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history