GetFunction API を使用した関数情報のクエリ - FC

関数の情報を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

fc:GetFunction

get

*All Resource

*

なし

リクエスト構文

GET /2021-04-06/services/{serviceName}/functions/{functionName} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
serviceName	string	必須	サービス名です。	service_name
functionName	string	必須	関数名です。	function_name

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
qualifier	string	任意	サービスのバージョンまたはエイリアスです。	demoQualifier
X-Fc-Account-Id	string	任意	ご利用の Alibaba Cloud アカウントの ID です。	188077086902****
X-Fc-Date	string	任意	関数を呼び出す時刻です。値のフォーマットは EEE, d MMM yyyy HH:mm:ss GMT です。	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	任意	カスタムリクエスト ID です。	asdf****

レスポンスフィールド

フィールド	型	説明	例
	object	関数の定義です。
codeChecksum	string	関数コードパッケージの CRC-64 値です。	2825179536350****
codeSize	integer	関数コードパッケージのサイズです。単位：バイト。	421
createdTime	string	関数が作成された時刻です。	2020-04-01T08:15:27Z
description	string	関数の説明文です。	test_description
environmentVariables	object	関数に設定された環境変数です。関数内からこれらの環境変数の値を取得できます。詳細については、「環境変数」をご参照ください。
	string	関数に設定した環境変数です。	{"key":"value"}
functionId	string	システムが関数に対して生成した ID です。各関数 ID は Function Compute 内で一意です。	aa715851-1c20-4b89-a8fb-***
functionName	string	関数名です。	function_name
handler	string	関数のハンドラです。詳細については、「関数ハンドラ」をご参照ください。	index.handler
lastModifiedTime	string	関数が最後に更新された時刻です。	2020-04-01T08:15:27Z
memorySize	integer	関数のメモリサイズです。単位：MB。値は 64 の倍数である必要があります。メモリサイズは関数インスタンスタイプによって異なります。詳細については、「インスタンスタイプ」をご参照ください。	256
runtime	string	関数のランタイムです。有効な値： nodejs20、nodejs18、nodejs16、nodejs14、nodejs12、nodejs10、nodejs8、nodejs6、nodejs4.4、python3.10、python3.9、python3、python2.7、java11、java8、go1、php7.2、dotnetcore2.1、custom.debian10、custom、custom-container。	python3
timeout	integer	関数実行のタイムアウト期間です。単位：秒。デフォルト値：60。有効範囲：1～600。この期間が経過すると、関数の実行は強制終了されます。	60
initializationTimeout	integer	Initializer フック実行のタイムアウト期間です。単位：秒。デフォルト値：3。有効範囲：1～300。この期間が経過すると、Initializer フックの実行は強制終了されます。	60
initializer	string	Initializer フックのハンドラです。値の形式は使用するプログラミング言語によって異なります。詳細については、「Initializer フック」をご参照ください。	index.handler
caPort	integer	カスタムランタイムまたはカスタムコンテナーランタイム用の HTTP サーバーがリッスンするポートです。	9000
customContainerConfig	CustomContainerConfigInfo	カスタムコンテナーランタイムの構成です。カスタムコンテナーランタイムを構成すると、カスタムコンテナイメージを使用して関数を実行できます。
layers	array	レイヤーのリスト（ARN V1）です。説明複数のレイヤーが存在する場合、配列の添字を降順に並べてマージされます。添字が小さいレイヤーの内容が、添字が大きいレイヤーの内容を上書きします。説明このパラメーターは非推奨です。代わりに layersArnV2 を使用してください。
	string	レイヤーリソースの名前（ARN V1 バージョン）です。	02f81d283888f5ec63442a88fe82b260#Layer-name#1
instanceConcurrency	integer	1 つのインスタンスで同時に処理可能なリクエスト数です。	10
instanceSoftConcurrency	integer	インスタンスのソフト同時実行数です。このパラメーターを使用して、インスタンスのグレースフルなスケールアップを実現できます。インスタンス上の同時リクエスト数がソフト同時実行数を超えると、インスタンスのスケールアップがトリガーされます。たとえば、インスタンスの起動に時間がかかる場合は、適切なソフト同時実行数を指定することで、事前にインスタンスを起動できます。この値は instanceConcurrency パラメーターの値以下である必要があります。	5
instanceType	string	関数のインスタンスタイプです。有効な値： e1：エラスティックインスタンス c1：パフォーマンスインスタンス fc.gpu.tesla.1：Tesla シリーズ GPU を搭載した GPU インスタンス fc.gpu.ampere.1：Ampere シリーズ GPU を搭載した GPU インスタンス fc.gpu.ada.1：Ada シリーズ GPU を搭載した GPU インスタンス g1：fc.gpu.tesla.1 と同等	e1
instanceLifecycleConfig	InstanceLifecycleConfig	インスタンスのライフサイクル構成です。
customDNS	CustomDNS	関数のカスタム DNS（Domain Name System）設定です。
customRuntimeConfig	CustomRuntimeConfig	カスタムランタイムで実行される関数の構成です。
customHealthCheckConfig	CustomHealthCheckConfig	関数のカスタムヘルスチェック構成です。このパラメーターは、カスタムランタイムおよびカスタムコンテナーランタイムでのみ適用されます。
layersArnV2	array	レイヤーのリスト（ARN V2）です。説明複数のレイヤーが存在する場合、配列の添字を降順に並べてマージされます。添字が小さいレイヤーの内容が、添字が大きいレイヤーの内容を上書きします。
	string	レイヤーリソースの名前（ARN V2 バージョン）です。	acs:fc:{region}:{accountID}:layers/{layerName}/versions/{layerVersion}
cpu	number	関数の vCPU 数です。値は 0.05 の倍数である必要があります。	1.5
diskSize	integer	関数のディスクサイズです。単位：MB。有効な値：512、10240。	512
gpuMemorySize	integer	関数の GPU メモリ容量です。単位：MB。値は 1,024 の倍数です。	2048

例

成功レスポンス

JSONJSON

{
  "codeChecksum": "2825179536350****",
  "codeSize": 421,
  "createdTime": "2020-04-01T08:15:27Z",
  "description": "test_description",
  "environmentVariables": {
    "key": "{\"key\":\"value\"}"
  },
  "functionId": "aa715851-1c20-4b89-a8fb-***",
  "functionName": "function_name",
  "handler": "index.handler",
  "lastModifiedTime": "2020-04-01T08:15:27Z",
  "memorySize": 256,
  "runtime": "python3",
  "timeout": 60,
  "initializationTimeout": 60,
  "initializer": "index.handler",
  "caPort": 9000,
  "customContainerConfig": {
    "args": "[\"-arg1\", \"value1\"]",
    "command": "[\"/code/myserver\"]",
    "image": "registry-vpc.cn-hangzhou.aliyuncs.com/fc-demo/helloworld:v1beta1",
    "accelerationType": "Default",
    "accelerationInfo": {
      "status": "Preparing"
    },
    "instanceID": "cri-xxxxxxxxxx",
    "webServerMode": true
  },
  "layers": [
    "02f81d283888f5ec63442a88fe82b260#Layer-name#1"
  ],
  "instanceConcurrency": 10,
  "instanceSoftConcurrency": 5,
  "instanceType": "e1",
  "instanceLifecycleConfig": {
    "preFreeze": {
      "handler": "index.preStop",
      "timeout": 10
    },
    "preStop": {
      "handler": "index.preStop",
      "timeout": 10
    }
  },
  "customDNS": {
    "nameServers": [
      "8.8.x.x"
    ],
    "searches": [
      "ns1.svc.cluster-domain.example"
    ],
    "dnsOptions": [
      {
        "name": "ndots",
        "value": "2"
      }
    ]
  },
  "customRuntimeConfig": {
    "command": [
      "/code/myBootstrap"
    ],
    "args": [
      "args1"
    ]
  },
  "customHealthCheckConfig": {
    "httpGetUrl": "/ready",
    "initialDelaySeconds": 1,
    "periodSeconds": 1,
    "timeoutSeconds": 2,
    "failureThreshold": 1,
    "successThreshold": 2
  },
  "layersArnV2": [
    "acs:fc:{region}:{accountID}:layers/{layerName}/versions/{layerVersion}"
  ],
  "cpu": 1.5,
  "diskSize": 512,
  "gpuMemorySize": 2048
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。