すべてのプロダクト
Search

このプロダクト

    :DescribeApi

    ドキュメントセンター

    :DescribeApi

    最終更新日:Dec 24, 2025

    指定された API の定義を取得します。

    操作説明

    • この操作はオープン API で利用できます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    apigateway:DescribeApi

    get

    *ApiGroup

    acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GroupId

    string

    任意

    API が属するグループの ID です。

    123
    ApiId

    string

    必須

    API の ID です。

    8afff6c8c4c6447abb035812e4d66b65

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ApiId

    string

    API の ID です。

    8afff6c8c4c6447abb035812e4d66b65
    ResultType

    string

    バックエンドサービスから返される応答のフォーマットです。有効値：JSON、TEXT、BINARY、XML、HTML。

    JSON
    WebSocketApiType

    string

    双方向 API のタイプ：

    • COMMON：共通 API

    • REGISTER：登録 API

    • UNREGISTER：登録解除 API

    • NOTIFY：ダウンストリーム通知

    COMMON
    DisableInternet

    boolean

    API が内部ネットワークからのみ呼び出し可能かどうかを指定します。有効値：

    • true：API は内部ネットワークからのみ呼び出すことができます。

    • false：API はインターネットおよび内部ネットワークから呼び出すことができます。

    false
    ResultBodyModel

    string

    API の返された結果です。

    {}
    ResultSample

    string

    バックエンドサービスからのサンプル応答です。

    200
    AppCodeAuthType

    string

    AuthType が APP に設定されている場合、このパラメーターが利用可能です。有効値：

    • DEFAULT：これはデフォルト値です。API グループの設定を継承します。

    • DISABLE：AppCode 認証は許可されません。

    • HEADER：AppCode 認証は、ヘッダーに AppCode を含むリクエストに対してのみ許可されます。

    • HEADER_QUERY：AppCode 認証は、ヘッダーまたはクエリパラメーターに AppCode を含むリクエストに対して許可されます。

    HEADER
    AllowSignatureMethod

    string

    AuthType が APP に設定されている場合、署名アルゴリズムを指定するためにこのパラメーターを指定する必要があります。このパラメーターを指定しない場合、デフォルトで HmacSHA256 が使用されます。有効値：

    • HmacSHA256

    • HmacSHA1,HmacSHA256

    HmacSHA256
    RegionId

    string

    API が存在するリージョンの ID です。

    cn-qingdao
    ForceNonceCheck

    boolean

    API 呼び出しに X-Ca-Nonce ヘッダーを含める必要があるかどうかを指定します。このヘッダーはリクエストの一意の識別子で、通常は UUID です。API Gateway はこのパラメーターを検証して、リプレイ攻撃を防ぎます。同じ値は 15 分以内に一度しか使用できません。有効値：

    • true：リプレイ攻撃を防ぐために、このフィールドは強制的にチェックされます。

    • false：このフィールドはチェックされません。

    true
    Visibility

    string

    API が公開されているかどうかを指定します。有効値：

    • PUBLIC：API は公開されています。このオプションを選択すると、API はコンソールの [API の検出] ページにすべてのユーザーに対して表示されます。

    • PRIVATE：API は非公開です。API が属する API グループが Alibaba Cloud Marketplace に掲載されている場合、API は掲載されません。

    PUBLIC
    FailResultSample

    string

    バックエンドサービスからの失敗した応答のサンプルです。

    400
    AuthType

    string

    API のセキュリティ認証タイプです。有効値：

    • APP：承認されたアプリケーションのみが API を呼び出すことができます。

    • ANONYMOUS：匿名呼び出しが許可されます。注意：

      • API サービス情報を取得した人は誰でもこの API を呼び出すことができます。API Gateway は呼び出し元に対して身分認証を実行せず、ユーザー固有の速度制限を適用できません。この API を公開する場合は、API の速度制限を設定します。

      • Alibaba Cloud Marketplace に ANONYMOUS API を掲載しないでください。API Gateway は個々の呼び出し元に対して課金や呼び出し回数の制限を実行できません。API グループを Alibaba Cloud Marketplace に掲載する場合は、API を別のグループに移動し、タイプを非公開に設定するか、Alibaba Cloud APP 認証方式を選択します。

    • APPOPENID：OpenID Connect と APP 認証が使用されます。承認されたアプリケーションのみが API を呼び出すことができます。このパラメーターをこの値に設定する場合は、OpenIdConnectConfig も設定する必要があります。

    APP
    ModifiedTime

    string

    API が最後に変更された時間です。

    2016-07-28T13:13:12Z
    RequestId

    string

    リクエスト ID です。

    D0FF585F-7966-40CF-BC60-75DB070B23D5<
    Description

    string

    API の説明です。

    Api description
    GroupName

    string

    API が属するグループの名前です。

    ApiTest
    GroupId

    string

    API が属するグループの ID です。

    08ae4aa0f95e4321849ee57f4e0b3077
    Mock

    string

    モックモードを有効にするかどうかを指定します。有効値：

    • OPEN：モックモードが有効です。

    • CLOSED：モックモードは有効ではありません。

    CLOSED
    MockResult

    string

    モックレスポンスです。

    test result
    CreatedTime

    string

    API が作成された時間です。

    2016-07-28T09:50:43Z
    ApiName

    string

    API の名前です。名前は API グループ内で一意である必要があります。

    ApiName
    BackendEnable

    boolean

    バックエンドサービスを有効にするかどうかを指定します。

    true
    BackendConfig

    object

    バックエンド構成です。

    BackendId

    string

    バックエンドサービスの ID です。

    0038e00c3dca44fcba3a94015d8f5bbf
    BackendType

    string

    バックエンドサービスのタイプです。

    HTTP
    BackendName

    string

    バックエンドサービスの名前です。

    testoss
    RequestConfig

    object

    コンシューマーから API Gateway に送信される API リクエストの構成です。

    BodyModel

    string

    本文モデルです。

    https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab
    RequestPath

    string

    API パスです。たとえば、API の完全な URL が http://api.a.com:8080/object/add?key1=value1&key2=value2 の場合、パスは /object/add です。

    /api/billing/test/[type]
    RequestHttpMethod

    string

    HTTP メソッドです。有効値：GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。

    POST
    BodyFormat

    string

    このパラメーターは、RequestMode が MAPPING に設定されている場合にのみ有効です。

    POST および PUT リクエストの場合、このパラメーターはデータがサーバーに渡される方法を指定します。有効値：FORM (キーと値のペア) および STREAM (バイトストリーム)。

    STREAM
    RequestMode

    string

    リクエストモードです。有効値：パラメータマッピングの場合は MAPPING、パラメータパススルーの場合は PASSTHROUGH。

    MAPPING
    PostBodyDescription

    string

    本文の説明です。

    fwefwef
    RequestProtocol

    string

    API でサポートされているプロトコルです。複数のプロトコルを選択できます。コンマ (,) で区切ります (例: "HTTP,HTTPS")。有効値：HTTP および HTTPS。

    HTTP
    EscapePathParam

    boolean

    パスパラメーターをエスケープするかどうかを指定します。このパラメーターが true に設定されている場合、パス内の `[param]` は通常の文字として扱われます。

    true
    ServiceConfig

    object

    API Gateway からバックエンドサービスに送信される API リクエストの構成です。

    AoneAppName

    string

    AONE アプリケーションの名前です。

    ib-blank
    MockStatusCode

    integer

    モックレスポンスの状態コードです。

    200
    ContentTypeValue

    string

    バックエンド HTTP サービスを呼び出し、ContentTypeCatagory が DEFAULT または CUSTOM に設定されている場合の Content-Type ヘッダーの値です。

    application/x-www-form-urlencoded; charset=UTF-8
    ServiceProtocol

    string

    バックエンドサービスのプロトコルです。HTTP と HTTPS のみがサポートされています。

    HTTP
    ServicePath

    string

    バックエンドサービスのパスです。たとえば、バックエンドサービスの完全な URL が http://api.a.com:8080/object/add?key1=value1&key2=value2 の場合、ServicePath は /object/add です。

    /object/add
    ContentTypeCatagory

    string

    バックエンド HTTP サービスを呼び出す際の Content-Type ヘッダーの値を設定するポリシー：

    • DEFAULT：API Gateway のデフォルト値を使用します。

    • CUSTOM：カスタム値を使用します。

    • CLIENT：クライアントリクエストの Content-Type ヘッダーを使用します。

    CUSTOM
    ServiceAddress

    string

    バックエンドサービスのアドレスです。たとえば、バックエンドサービスの完全な URL が http://api.a.com:8080/object/add?key1=value1&key2=value2 の場合、ServiceAddress は http://api.a.com:8080 です。

    http://api.a.com:8080
    Mock

    string

    モックモードを有効にするかどうかを指定します。有効値：

    • TRUE：モックモードが有効です。

    • FALSE：モックモードは有効ではありません。

    TRUE
    ServiceVpcEnable

    string

    VPC チャンネルを有効にするかどうかを指定します。有効値：

    • TRUE：VPC チャンネルが有効です。VPC チャンネルを有効にする前に、VPC 権限付与を追加する必要があります。

    • FALSE：VPC チャンネルは有効ではありません。

    TRUE
    MockResult

    string

    モックモードで返される結果です。

    test result
    ServiceHttpMethod

    string

    バックエンドサービスを呼び出すために使用される HTTP メソッドです。有効値：GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。

    POST
    ServiceTimeout

    integer

    バックエンドサービスのタイムアウト期間 (ミリ秒) です。

    1000
    MockHeaders

    object

    MockHeader

    array<object>

    モックヘッダーです。

    object

    HeaderValue

    string

    HTTP ヘッダーパラメーターの値です。

    86400
    HeaderName

    string

    HTTP ヘッダーパラメーターの名前です。

    Content-Length
    VpcConfig

    object

    VPC チャンネルの構成です。

    VpcId

    string

    VPC の ID です。

    vpc-2zeafsc3fygk1***
    VpcScheme

    string

    VPC プロトコルです。

    HTTP
    InstanceId

    string

    VPC 内のインスタンスの ID (ECS インスタンスや Server Load Balancer インスタンスなど) です。

    i-bp1h497hkijewv2***
    Port

    integer

    インスタンスのポート番号です。

    8080
    Name

    string

    VPC 権限付与の名前です。

    glmall-app-test
    FunctionComputeConfig

    object

    バックエンドサービスが Function Compute の場合のバックエンド構成です。

    FcType

    string

    Function Compute サービスのタイプです。

    HttpTrigger
    RoleArn

    string

    API Gateway が Function Compute にアクセスすることを承認する RAM ロールの ARN です。

    acs:ram::111***:role/aliyunserviceroleforsas
    Method

    string

    リクエストメソッドです。

    GET
    FcBaseUrl

    string

    Function Compute サービスのルートパスです。

    https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/
    ContentTypeValue

    string

    バックエンドの Function Compute サービスを呼び出し、ContentTypeCatagory が DEFAULT または CUSTOM に設定されている場合の Content-Type ヘッダーの値です。

    application/x-www-form-urlencoded; charset=UTF-8
    RegionId

    string

    Function Compute がデプロイされているリージョンです。

    cn-qingdao
    OnlyBusinessPath

    boolean

    バックエンドがビジネスパスのみを受け取るかどうかを指定します。

    false
    FunctionName

    string

    Function Compute の関数の名前です。

    edge_function
    ContentTypeCatagory

    string

    バックエンドの Function Compute サービスを呼び出す際の Content-Type ヘッダーの値を設定するポリシー：

    • DEFAULT：API Gateway のデフォルト値を使用します。

    • CUSTOM：カスタム値を使用します。

    • CLIENT：クライアントリクエストの Content-Type ヘッダーを使用します。

    DEFAULT
    Path

    string

    API リクエストパスです。

    /api/offline/cacheData
    ServiceName

    string

    Function Compute のサービスの名前です。

    fcservicename
    Qualifier

    string

    関数のエイリアスです。

    2
    TriggerName

    string

    test1
    FcVersion

    string

    OssConfig

    object

    OSS バックエンドに関する情報です。

    Key

    string

    OSS に保存されているオブジェクトまたはフォルダのパスです。

    /folder/test.json
    Action

    string

    OSS 操作です。有効値：

    • GetObject

    • PostObject

    • DeleteObject

    • PutObject

    • HeadObject

    • GetObjectMeta

    • AppendObject

    GetObject
    OssRegionId

    string

    OSS サービスが配置されているリージョンの ID です。

    cn-hangzhou
    BucketName

    string

    OSS バケットです。

    cbg-db
    EventBridgeConfig

    object

    EventBridge の設定です。

    EventBus

    string

    イベントバスです。

    testBus
    EventSource

    string

    イベントソースです。

    baas_driver
    EventBridgeRegionId

    string

    EventBridge サービスが配置されているリージョンの ID です。

    cn-beijing
    RoleArn

    string

    API Gateway が EventBridge にアクセスすることを承認する RAM ロールの ARN です。

    acs:ram::1933122015759***:role/adminoidcaliyun
    OpenIdConnectConfig

    object

    サードパーティの身分認証サービスである OpenID Connect の構成です。

    OpenIdApiType

    string

    OpenID Connect モードです。有効値：

    • IDTOKEN：トークンを発行する承認 API です。このパラメーターをこの値に設定する場合は、PublicKeyId と PublicKey も設定する必要があります。

    • BUSINESS：トークンを検証するビジネス API です。このパラメーターをこの値に設定する場合は、IdTokenParamName も設定する必要があります。

    IDTOKEN
    IdTokenParamName

    string

    トークンに対応するパラメーターの名前です。

    xxx
    PublicKeyId

    string

    公開鍵 ID です。

    88483727556929326703309904351185815489
    PublicKey

    string

    公開鍵です。

    EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92
    ErrorCodeSamples

    object

    ErrorCodeSample

    array<object>

    バックエンドサービスから返されるサンプルエラーコードです。

    object

    Code

    string

    エラーコードです。

    400
    Model

    string

    モデルです。

    [\"*\"]
    Message

    string

    エラーメッセージです。

    Missing the parameter UserId
    Description

    string

    説明です。

    The UserId parameter is missing from the request.

    SystemParameters

    object

    SystemParameter

    array<object>

    API Gateway がバックエンドサービスに送信するシステムパラメーターです。

    object

    DemoValue

    string

    サンプル値です。

    192.168.1.1
    Description

    string

    パラメーターの説明です。

    Client IP Address

    ParameterName

    string

    システムパラメーターの名前です。有効値：CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy。

    CaClientIp
    Location

    string

    パラメーターの位置です。有効値：BODY、HEAD、QUERY、PATH。

    HEAD
    ServiceParameterName

    string

    対応するバックエンドパラメーターの名前です。

    clientIp
    CustomSystemParameters

    object

    CustomSystemParameter

    array<object>

    カスタムシステムパラメーターのリストです。

    object

    DemoValue

    string

    サンプル値です。

    192.168.1.1
    Description

    string

    パラメーターの説明です。

    Client IP Address

    ParameterName

    string

    システムパラメーターの名前です。有効値：CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy。

    CaClientIp
    Location

    string

    パラメーターの位置です。有効値：BODY、HEAD、QUERY、PATH。

    HEAD
    ServiceParameterName

    string

    対応するバックエンドパラメーターの名前です。

    clientIp
    ConstantParameters

    object

    ConstantParameter

    array<object>

    API Gateway がバックエンドサービスに送信する定数パラメータです。

    object

    Description

    string

    パラメーターの説明です。

    constance
    Location

    string

    パラメーターの位置です。有効値：BODY、HEAD、QUERY、PATH。

    HEAD
    ServiceParameterName

    string

    バックエンドパラメーターの名前です。

    constance
    ConstantValue

    string

    パラメーター値です。

    constance
    RequestParameters

    object

    RequestParameter

    array<object>

    コンシューマーが API Gateway に送信する API リクエストのパラメーターの説明です。

    object

    JsonScheme

    string

    ParameterType が String の場合の検証用の JSON スキーマです。

    JSON
    MaxValue

    integer

    パラメーターの最大値です。このパラメーターは、ParameterType が Int、Long、Float、または Double の場合に有効です。

    123456
    ArrayItemsType

    string

    配列要素のタイプです。

    String
    MinValue

    integer

    パラメーターの最小値です。このパラメーターは、ParameterType が Int、Long、Float、または Double の場合に有効です。

    123456
    DocShow

    string

    ドキュメントが表示されるかどうかを指定します。有効値：PUBLIC および PRIVATE。

    PUBLIC
    MaxLength

    integer

    パラメーターの最大長です。このパラメーターは、ParameterType が String の場合に有効です。

    123456
    DefaultValue

    string

    デフォルト値です。

    20
    ApiParameterName

    string

    パラメーター名です。

    age
    EnumValue

    string

    ParameterType が Int、Long、Float、Double、または String の場合のパラメーターの有効値です。複数の値をコンマ (,) で区切ります (例: 1,2,3,4,9 または A,B,C,E,F)。

    boy,girl
    DemoValue

    string

    サンプル値です。

    20
    Required

    string

    パラメーターが必須かどうかを指定します。有効値：REQUIRED および OPTIONAL。

    OPTIONAL
    Description

    string

    パラメーターの説明です。

    Age

    ParameterType

    string

    パラメータータイプです。有効値：String、Int、Long、Float、Double、Boolean。

    String
    RegularExpression

    string

    ParameterType が String の場合の検証に使用される正規表現です。

    xxx
    MinLength

    integer

    パラメーターの最小長です。このパラメーターは、ParameterType が String の場合に有効です。

    123456
    DocOrder

    integer

    ドキュメント内のシーケンス番号です。

    0
    Location

    string

    パラメーターの位置です。有効値：BODY、HEAD、QUERY、PATH。

    HEAD
    ServiceParameters

    object

    ServiceParameter

    array<object>

    API Gateway がバックエンドサービスに送信する API リクエストのパラメーターの説明です。

    object

    Location

    string

    パラメーターの位置です。有効値：BODY、HEAD、QUERY、PATH。

    HEAD
    ParameterType

    string

    バックエンドパラメーターのデータの型です。有効値：STRING、NUMBER、BOOLEAN。

    String
    ServiceParameterName

    string

    バックエンドパラメーターの名前です。

    clientIp
    ServiceParametersMap

    object

    ServiceParameterMap

    array<object>

    フロントエンドリクエストパラメーターとバックエンドリクエストパラメーター間のマッピングです。

    object

    RequestParameterName

    string

    フロントエンドリクエストパラメーターの名前です。この値は `RequestParameters` オブジェクトに存在し、`RequestParameter` の `ApiParameterName` と一致する必要があります。

    sex
    ServiceParameterName

    string

    バックエンドパラメーターの名前です。

    sex
    DeployedInfos

    object

    DeployedInfo

    array<object>

    API の公開ステータスです。

    object

    StageName

    string

    環境の名前です。有効値：RELEASE および TEST。

    RELEASE
    EffectiveVersion

    string

    有効なバージョンです。

    xxx
    DeployedStatus

    string

    デプロイメントステータスです。有効値：DEPLOYED (デプロイ済み) および NONDEPLOYED (未デプロイ)。

    DEPLOYED
    TagList

    object

    Tag

    array<object>

    タグのリストです。

    object

    TagKey

    string

    タグキーです。

    APP
    TagValue

    string

    タグ値です。

    value3

    例

    成功レスポンス

    JSONJSON

    {
  "ApiId": "8afff6c8c4c6447abb035812e4d66b65",
  "ResultType": "JSON",
  "WebSocketApiType": "COMMON",
  "DisableInternet": false,
  "ResultBodyModel": "{}",
  "ResultSample": "200",
  "AppCodeAuthType": "HEADER",
  "AllowSignatureMethod": "HmacSHA256",
  "RegionId": "cn-qingdao",
  "ForceNonceCheck": true,
  "Visibility": "PUBLIC",
  "FailResultSample": "400",
  "AuthType": "APP",
  "ModifiedTime": "2016-07-28T13:13:12Z",
  "RequestId": "D0FF585F-7966-40CF-BC60-75DB070B23D5<",
  "Description": "Api description",
  "GroupName": "ApiTest",
  "GroupId": "08ae4aa0f95e4321849ee57f4e0b3077",
  "Mock": "CLOSED",
  "MockResult": "test result",
  "CreatedTime": "2016-07-28T09:50:43Z",
  "ApiName": "ApiName",
  "BackendEnable": true,
  "BackendConfig": {
    "BackendId": "0038e00c3dca44fcba3a94015d8f5bbf",
    "BackendType": "HTTP",
    "BackendName": "testoss"
  },
  "RequestConfig": {
    "BodyModel": "https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab",
    "RequestPath": "/api/billing/test/[type]",
    "RequestHttpMethod": "POST",
    "BodyFormat": "STREAM",
    "RequestMode": "MAPPING",
    "PostBodyDescription": "fwefwef",
    "RequestProtocol": "HTTP",
    "EscapePathParam": true
  },
  "ServiceConfig": {
    "AoneAppName": "ib-blank",
    "MockStatusCode": 200,
    "ContentTypeValue": "application/x-www-form-urlencoded; charset=UTF-8",
    "ServiceProtocol": "HTTP",
    "ServicePath": "/object/add",
    "ContentTypeCatagory": "CUSTOM",
    "ServiceAddress": "http://api.a.com:8080",
    "Mock": "TRUE",
    "ServiceVpcEnable": "TRUE",
    "MockResult": "test result",
    "ServiceHttpMethod": "POST",
    "ServiceTimeout": 1000,
    "MockHeaders": {
      "MockHeader": [
        {
          "HeaderValue": "86400",
          "HeaderName": "Content-Length"
        }
      ]
    },
    "VpcConfig": {
      "VpcId": "vpc-2zeafsc3fygk1***",
      "VpcScheme": "HTTP",
      "InstanceId": "i-bp1h497hkijewv2***",
      "Port": 8080,
      "Name": "glmall-app-test"
    },
    "FunctionComputeConfig": {
      "FcType": "HttpTrigger",
      "RoleArn": "acs:ram::111***:role/aliyunserviceroleforsas",
      "Method": "GET",
      "FcBaseUrl": "https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/",
      "ContentTypeValue": "application/x-www-form-urlencoded; charset=UTF-8",
      "RegionId": "cn-qingdao",
      "OnlyBusinessPath": false,
      "FunctionName": "edge_function",
      "ContentTypeCatagory": "DEFAULT",
      "Path": "/api/offline/cacheData",
      "ServiceName": "fcservicename",
      "Qualifier": "2",
      "TriggerName": "test1",
      "FcVersion": ""
    },
    "OssConfig": {
      "Key": "/folder/test.json",
      "Action": "GetObject",
      "OssRegionId": "cn-hangzhou",
      "BucketName": "cbg-db"
    },
    "EventBridgeConfig": {
      "EventBus": "testBus",
      "EventSource": "baas_driver",
      "EventBridgeRegionId": "cn-beijing",
      "RoleArn": "acs:ram::1933122015759***:role/adminoidcaliyun"
    }
  },
  "OpenIdConnectConfig": {
    "OpenIdApiType": "IDTOKEN",
    "IdTokenParamName": "xxx",
    "PublicKeyId": "88483727556929326703309904351185815489",
    "PublicKey": "EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92"
  },
  "ErrorCodeSamples": {
    "ErrorCodeSample": [
      {
        "Code": "400",
        "Model": "[\\\"*\\\"]",
        "Message": "Missing the parameter UserId",
        "Description": "The UserId parameter is missing from the request.\n"
      }
    ]
  },
  "SystemParameters": {
    "SystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "Client IP Address\n",
        "ParameterName": "CaClientIp",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "CustomSystemParameters": {
    "CustomSystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "Client IP Address\n",
        "ParameterName": "CaClientIp",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ConstantParameters": {
    "ConstantParameter": [
      {
        "Description": "constance",
        "Location": "HEAD",
        "ServiceParameterName": "constance",
        "ConstantValue": "constance"
      }
    ]
  },
  "RequestParameters": {
    "RequestParameter": [
      {
        "JsonScheme": "JSON",
        "MaxValue": 123456,
        "ArrayItemsType": "String",
        "MinValue": 123456,
        "DocShow": "PUBLIC",
        "MaxLength": 123456,
        "DefaultValue": "20",
        "ApiParameterName": "age",
        "EnumValue": "boy,girl",
        "DemoValue": "20",
        "Required": "OPTIONAL",
        "Description": "Age\n",
        "ParameterType": "String",
        "RegularExpression": "xxx",
        "MinLength": 123456,
        "DocOrder": 0,
        "Location": "HEAD"
      }
    ]
  },
  "ServiceParameters": {
    "ServiceParameter": [
      {
        "Location": "HEAD",
        "ParameterType": "String",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ServiceParametersMap": {
    "ServiceParameterMap": [
      {
        "RequestParameterName": "sex",
        "ServiceParameterName": "sex"
      }
    ]
  },
  "DeployedInfos": {
    "DeployedInfo": [
      {
        "StageName": "RELEASE",
        "EffectiveVersion": "xxx",
        "DeployedStatus": "DEPLOYED"
      }
    ]
  },
  "TagList": {
    "Tag": [
      {
        "TagKey": "APP",
        "TagValue": "value3"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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