すべてのプロダクト
Search

このプロダクト

    :DescribeApi

    ドキュメントセンター

    :DescribeApi

    最終更新日:Mar 16, 2026

    指定された 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：ダウンストリーム通知 API。

    COMMON
    DisableInternet

    boolean

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

    • true：API は内部ネットワーク呼び出しのみをサポートします。

    • false：呼び出しソースに制限はありません。

    false
    ResultBodyModel

    string

    API の応答本文。

    {}
    ResultSample

    string

    バックエンドサービスから返される応答例。

    200
    AppCodeAuthType

    string

    AuthType が APP に設定されている場合にのみ有効です。有効な値：

    • DEFAULT：デフォルト値。グループの設定を使用します。

    • DISABLE：無効。

    • HEADER：ヘッダーで AppCode 認証を有効にします。

    • HEADER_QUERY：ヘッダーとクエリ文字列の両方で AppCode 認証を有効にします。

    HEADER
    AllowSignatureMethod

    string

    AuthType が APP に設定されている場合に必要です。署名アルゴリズムを指定します。有効な値：HmacSHA256 および HmacSHA1,HmacSHA256。デフォルト：HmacSHA256。

    • HmacSHA256

    • HmacSHA1,HmacSHA256

    HmacSHA256
    RegionId

    string

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

    cn-qingdao
    ForceNonceCheck

    boolean

    リクエストヘッダー X-Ca-Nonce が必要かどうかを指定します。このヘッダーはリクエストの一意の ID で、通常は UUID です。API Gateway はこのヘッダーを検証して、リプレイ攻撃を防ぎます。各値は 15 分以内に 1 回しか使用できません。有効な値：

    • true：このヘッダーの検証を強制して、リプレイ攻撃を防ぎます。

    • false：このヘッダーを検証しません。

    true
    Visibility

    string

    API がパブリックかどうかを指定します。有効な値：

    • PUBLIC：パブリック。選択した場合、API はコンソールの [Discover APIs] ページにすべてのユーザーに対して表示されます。

    • PRIVATE：プライベート。選択した場合、グループがリストされても API は Alibaba Cloud Marketplace に表示されません。

    PUBLIC
    FailResultSample

    string

    バックエンドサービスから返されるエラー応答の例。

    400
    AuthType

    string

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

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

    • ANONYMOUS：匿名呼び出しが許可されます。次の点にご注意ください：

      • API エンドポイントにアクセスできる人なら誰でも呼び出すことができます。API Gateway は本人確認を実行せず、ユーザーごとの速度制限を適用できません。この API を公開する場合は、API レベルで速度制限を設定してください。

      • Alibaba Cloud Marketplace に ANONYMOUS API をリストすることは推奨しません。API Gateway は匿名呼び出しを測定または制限できません。ご利用のグループが Alibaba Cloud Marketplace にリストされている場合は、この API を別のグループに移動するか、可視性を PRIVATE に設定するか、Alibaba Cloud APP 認証を使用してください。

    • APPOPENID：サードパーティの OpenID Connect 認証をサポートし、権限を付与されたアプリケーションのみが 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 の名前。グループ内で一意である必要があります。

    ApiName
    BackendEnable

    boolean

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

    true
    BackendConfig

    object

    バックエンド構成。

    BackendId

    string

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

    0038e00c3dca44fcba3a94015d8f5bbf
    BackendType

    string

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

    HTTP
    BackendName

    string

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

    testoss
    RequestConfig

    object

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

    BodyModel

    string

    本文モデル。

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

    string

    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、HEAD、TRACE、PATCH、CONNECT、OPTIONS。

    POST
    BodyFormat

    string

    RequestMode が MAPPING の場合にのみ有効です。POST または PUT リクエストでサーバーにデータを送信する方法を指定します。有効な値は FORM (キーと値のペア) と STREAM (バイトストリーム) です。

    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 からバックエンドサービスに送信されるリクエストの構成。

    AoneAppName

    string

    Aone アプリケーションの名前。

    ib-blank
    MockStatusCode

    integer

    モック応答によって返されるステータスコード。

    200
    ContentTypeValue

    string

    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 の場合、パスは /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 の場合、エンドポイントは http://api.a.com:8080 です。

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

    string

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

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

    • FALSE：モックモードは無効です。

    TRUE
    ServiceVpcEnable

    string

    VPC チャネルが有効かどうかを指定します。有効な値：

    • TRUE：VPC チャネルは有効です。この機能を有効にする前に、まず VPC を承認する必要があります。

    • FALSE：VPC チャネルは無効です。

    TRUE
    MockResult

    string

    モックモードが有効な場合に返される応答。

    test result
    ServiceHttpMethod

    string

    バックエンドサービスを呼び出すために使用される HTTP メソッド。有効な値：GET、POST、DELETE、PUT、HEAD、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 内のインスタンス (ECS または Server Load Balancer) の ID。

    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

    HTTP メソッド。

    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

    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

    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

    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

    説明。

    请求缺少参数 UserId
    SystemParameters

    object

    SystemParameter

    array<object>

    API Gateway からバックエンドサービスに送信されるシステムパラメーター。

    object

    DemoValue

    string

    値の例。

    192.168.1.1
    Description

    string

    パラメーターの説明。

    客户端IP
    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

    パラメーターの説明。

    客户端IP
    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 に送信されるパラメーター。

    object

    JsonScheme

    string

    JSON スキーマ検証。ParameterType が String の場合にのみ有効です。

    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

    パラメーターの説明。

    年龄
    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 リクエストでゲートウェイがバックエンドサービスに送信するパラメーター。

    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

    フロントエンドリクエストパラメーター名に対応します。この値は RequestParametersObject に存在し、RequestParam.ApiParameterName と一致する必要があります。

    name
    ServiceParameterName

    string

    バックエンドパラメーター名

    name
    DeployedInfos

    object

    DeployedInfo

    array<object>

    API 公開ステータス

    object

    StageName

    string

    環境名は RELEASE または TEST です。

    RELEASE
    EffectiveVersion

    string

    有効なバージョン。

    xxx
    DeployedStatus

    string

    デプロイステータス。有効な値：DEPLOYED および NONDEPLOYED。DEPLOYED は API がデプロイされていることを示し、NONDEPLOYED は API がデプロイされていないことを示します。

    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": "",
      "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": "请求缺少参数 UserId"
      }
    ]
  },
  "SystemParameters": {
    "SystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "客户端IP",
        "ParameterName": "CaClientIp",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "CustomSystemParameters": {
    "CustomSystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "客户端IP",
        "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": "年龄",
        "ParameterType": "String",
        "RegularExpression": "xxx",
        "MinLength": 123456,
        "DocOrder": 0,
        "Location": "HEAD"
      }
    ]
  },
  "ServiceParameters": {
    "ServiceParameter": [
      {
        "Location": "HEAD",
        "ParameterType": "String",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ServiceParametersMap": {
    "ServiceParameterMap": [
      {
        "RequestParameterName": "name",
        "ServiceParameterName": "name"
      }
    ]
  },
  "DeployedInfos": {
    "DeployedInfo": [
      {
        "StageName": "RELEASE",
        "EffectiveVersion": "xxx",
        "DeployedStatus": "DEPLOYED"
      }
    ]
  },
  "TagList": {
    "Tag": [
      {
        "TagKey": "APP",
        "TagValue": "value3"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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