All Products
Search
Document Center

BSS OpenAPI:DescribeResourcePackageProduct

Last Updated:Mar 01, 2024

Queries the information about resource plans of an Alibaba Cloud service.

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:DescribeResourcePackageProductREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductCodestringYes

The code of the service.

ossbag

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code returned.

Success
Messagestring

The message returned.

Successful!
RequestIdstring

The ID of the request.

BBEF51A3-E933-4F40-A534-C673CBDB9C80
Successboolean

Indicates whether the request is successful.

true
OrderIdlong

The ID of the order.

72353765387
Dataobject

The data returned.

ResourcePackagesobject []

The details about the resource plans.

ProductTypestring

The type of the service.

ossbag
Namestring

The name of the resource plan.

Object Storage Service (OSS) resource plan (monthly)
ProductCodestring

The code of the service.

ossbag
PackageTypesobject []

The types of the resource plans.

Codestring

The code of the resource plan.

FPT_ossbag_deadlineAcc_CdnOut_common_sz
Namestring

The name of the resource plan type.

Back-to-origin traffic plan - China (Shenzhen)
Propertiesobject []

The properties of the resource plan.

Namestring

The name of the property.

region
Valuestring

The value of the property.

cn-shenzhen
Specificationsobject []

The specifications of the resource plan.

Namestring

The name of the specification.

1TB
Valuestring

The value of the specification.

1024
AvailableDurationsobject []

The validity periods available for the resource plan.

Valueinteger

The value of the validity period.

6
Namestring

The name of the validity period.

6 Month
Unitstring

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

  • Month
  • Year

Default value: Month.

Month

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "BBEF51A3-E933-4F40-A534-C673CBDB9C80",
  "Success": true,
  "OrderId": 72353765387,
  "Data": {
    "ResourcePackages": {
      "ResourcePackage": [
        {
          "ProductType": "ossbag",
          "Name": "Object Storage Service (OSS) resource plan (monthly)\n",
          "ProductCode": "ossbag",
          "PackageTypes": {
            "PackageType": [
              {
                "Code": "FPT_ossbag_deadlineAcc_CdnOut_common_sz",
                "Name": "Back-to-origin traffic plan - China (Shenzhen)\n",
                "Properties": {
                  "Property": [
                    {
                      "Name": "region",
                      "Value": "cn-shenzhen"
                    }
                  ]
                },
                "Specifications": {
                  "Specification": [
                    {
                      "Name": "1TB",
                      "Value": "1024",
                      "AvailableDurations": {
                        "AvailableDuration": [
                          {
                            "Value": 6,
                            "Name": "6 Month",
                            "Unit": "Month"
                          }
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

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.
400ProductCodeMissingParameter ProductCode is missing.-
400ProductNotSupportedProduct 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.