All Products
Search
Document Center

Function Compute:Context

Last Updated:Feb 02, 2024

This topic describes the context that is involved when you write code in the PHP runtime environment of Function Compute.

What is context?

When Function Compute runs your function, the system passes a context object to the method that is used to execute the function. The context object contains information about the invocation, service, function, and runtime environment.

In the PHP runtime environment, the value of the $context parameter is of the array type. The following code provides an example on how to define the $context parameter:

[
  'requestId' => 'b1c5100f-819d-c421-3a5e-7782a27d8a33',
  'credentials' => [
    'accessKeyId' => 'STS.access_key_id',
    'accessKeySecret' => 'access_key_secret',
    'securityToken' => 'security_token',
  ],
  'function' => [
    'name' => 'my-func',
    'handler' => 'index.handler',
    'memory' => 128,
    'timeout' => 10,
    'initializer' => 'index.initializer',
    'initializationTimeout' => 10,
  ],
  'service' =>[
     'logProject' => 'my-log-project',
     'logStore' => 'my-log-store',
     'qualifier' => 'qualifier',
     'versionId' => '1'
  ],
  'region' => 'cn-shanghai',
  'accountId' => '123456',
  'tracing': {
    'openTracingSpanContext': 'xxxxxxxxxxxx',
    'jaegerEndpoint': 'xxxxxxxx',
    'openTracingSpanBaggages': []
  }
]

The following table describes the information that is contained in the $context parameter.

Field

Type

Description

requestId

String

The unique ID of the request that is used to invoke the function. You can record the ID for troubleshooting if an error occurs.

credentials

An array that contains the following fields:

  • accessKeyId

  • accessKeySecret

  • securityToken

The temporary AccessKey pair that Function Compute obtains by assuming your service-linked role. The temporary AccessKey pair is valid for 36 hours. You can use credentials in your code to access related services such as Object Storage Service (OSS). This way, you can access the services without the need to write your AccessKey pair in the function code. For more information, see Grant Function Compute permissions to access other Alibaba Cloud services.

function

An array that contains the following fields:

  • name

  • handler

  • memory

  • timeout

  • initializer

  • initializationTimeout

The basic information about the invoked function, such as the name, handler, memory, and timeout period of the function.

service

An array that contains the following fields:

  • logProject

  • logStore

  • qualifier

  • versionId

The information about the service to which the function belongs, such as the name, the related project, and Logstore in Simple Log Service, the version, and the alias of the service. The qualifier parameter indicates the version or alias of the service that is specified when you invoke a function. The versionId parameter indicates the version of the service that is actually invoked.

region

String

The ID of the region in which the function is invoked. For example, if the function is invoked in the China (Shanghai) region, the region ID is cn-shanghai. For more information, see Service endpoints.

accountId

String

The ID of the Alibaba Cloud account to which the function belongs.