GetPackage-阿里云帮助中心

Obtains the information about a package.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

odps:GetPackage

get

*Project

acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}

None

Request syntax

GET /api/v1/projects/{projectName}/packages/{packageName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
projectName	string	Yes	The name of the MaxCompute project.	projectA
packageName	string	Yes	The name of the package.	test_package

Request parameters

Parameter	Type	Required	Description	Example
sourceProject	string	No	The project to which the package belongs. This parameter is required if the package is installed in the MaxCompute project.	projectB

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	The ID of the request.	0b57ff8316614119858417939e3e54
httpCode	integer	Indicates whether the request was successful. If this parameter was not empty and the value of this parameter was not 200, the request failed.	200
errorCode	string	The error code returned if the request failed.	040002
errorMsg	string	The error message.	error message.
data	object	The returned data.
allowedProjectList	array<object>	The projects in which the package is installed.
	object	The projects in which the package is installed.
label	string	The security level for sensitive data.	2
project	string	The name of the MaxCompute project.	proejctB
resourceList	object	The details of the resources that are included in the package.
table	array<object>	The tables.
	object	The tables.
name	string	The name of the table.	dim_odps
schemaName	string	The name of schema.	default
actions	array	The operations that were performed on the table.
	string	The operations that were performed on the table.	describe
resource	array<object>	The resources.
	object	The resources.
name	string	The name of the resource.	res_1
schemaName	string	The name of schema.	default
actions	array	The operations that were performed on the resource.
	string	The operations that were performed on the resource.	read
function	array<object>	The functions.
	object	The functions.
name	string	The name of the function.	function_1
schemaName	string	The name of schema.	default
actions	array	The operations that were performed on the function.
	string	The operations that were performed on the function.	read

Examples

Success response

JSON format

{
  "requestId": "0b57ff8316614119858417939e3e54",
  "httpCode": 200,
  "errorCode": "040002",
  "errorMsg": "error message.",
  "data": {
    "allowedProjectList": [
      {
        "label": "2",
        "project": "proejctB"
      }
    ],
    "resourceList": {
      "table": [
        {
          "name": "dim_odps\n",
          "schemaName": "default",
          "actions": [
            "describe"
          ]
        }
      ],
      "resource": [
        {
          "name": "res_1",
          "schemaName": "default",
          "actions": [
            "read"
          ]
        }
      ],
      "function": [
        {
          "name": "function_1",
          "schemaName": "default",
          "actions": [
            "read"
          ]
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.