All Products
Search

This Product

    API Gateway:DescribeApi

    Document Center

    API Gateway:DescribeApi

    Last Updated:Mar 16, 2026

    Mengkueri definisi API tertentu.

    Deskripsi operasi

    • Operasi ini ditujukan untuk pengguna yang menerbitkan API.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    apigateway:DescribeApi

    get

    *ApiGroup

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    GroupId

    string

    No

    ID grup yang berisi API tersebut.

    123
    ApiId

    string

    Yes

    ID API tersebut.

    8afff6c8c4c6447abb035812e4d66b65

    Elemen respons

    Element

    Type

    Description

    Example

    object

    ApiId

    string

    ID API tersebut.

    8afff6c8c4c6447abb035812e4d66b65
    ResultType

    string

    Format respons yang dikembalikan oleh layanan backend. Nilai yang valid: JSON, TEXT, BINARY, XML, dan HTML.

    JSON
    WebSocketApiType

    string

    Tipe API komunikasi dua arah:

    • COMMON: API standar.

    • REGISTER: API pendaftaran.

    • UNREGISTER: API pembatalan pendaftaran.

    • NOTIFY: API notifikasi downstream.

    COMMON
    DisableInternet

    boolean

    Menentukan apakah API hanya mendukung panggilan jaringan internal. Nilai yang valid:

    • true: API hanya mendukung panggilan jaringan internal.

    • false: Tidak ada batasan pada sumber panggilan.

    false
    ResultBodyModel

    string

    Badan respons API.

    {}
    ResultSample

    string

    Contoh respons yang dikembalikan oleh layanan backend.

    200
    AppCodeAuthType

    string

    Hanya berlaku ketika AuthType diatur ke APP. Nilai yang valid:

    • DEFAULT: Nilai default. Menggunakan pengaturan grup.

    • DISABLE: Dinonaktifkan.

    • HEADER: Mengaktifkan autentikasi AppCode di header.

    • HEADER_QUERY: Mengaktifkan autentikasi AppCode di header dan string kueri.

    HEADER
    AllowSignatureMethod

    string

    Diperlukan ketika AuthType diatur ke APP. Menentukan algoritma signature. Nilai yang valid: HmacSHA256 dan HmacSHA1,HmacSHA256. Default: HmacSHA256.

    • HmacSHA256

    • HmacSHA1,HmacSHA256

    HmacSHA256
    RegionId

    string

    ID wilayah tempat API berada.

    cn-qingdao
    ForceNonceCheck

    boolean

    Menentukan apakah header permintaan X-Ca-Nonce diperlukan. Header ini merupakan ID unik permintaan, biasanya berupa UUID. API Gateway memvalidasi header ini untuk mencegah serangan replay. Setiap nilai hanya dapat digunakan sekali dalam rentang 15 menit. Nilai yang valid:

    • true: Mewajibkan validasi header ini untuk mencegah serangan replay.

    • false: Tidak memvalidasi header ini.

    true
    Visibility

    string

    Menentukan apakah API bersifat publik. Nilai yang valid:

    • PUBLIC: Publik. Jika dipilih, API akan muncul di halaman Discover APIs di Konsol untuk semua pengguna.

    • PRIVATE: Pribadi. Jika dipilih, API tidak akan muncul di Alibaba Cloud Marketplace saat grup tersebut terdaftar.

    PUBLIC
    FailResultSample

    string

    Contoh respons kesalahan yang dikembalikan oleh layanan backend.

    400
    AuthType

    string

    Jenis autentikasi keamanan untuk API. Nilai yang valid:

    • APP: Hanya aplikasi yang telah diotorisasi yang dapat memanggil API.

    • ANONYMOUS: Panggilan anonim diizinkan. Perhatikan hal berikut:

      • Siapa pun yang memiliki akses ke titik akhir API dapat memanggilnya. API Gateway tidak melakukan verifikasi identitas dan tidak dapat menerapkan pembatasan kecepatan per pengguna. Jika Anda memublikasikan API ini, konfigurasikan pembatasan kecepatan di tingkat API.

      • Kami tidak merekomendasikan mencantumkan API ANONYMOUS di Alibaba Cloud Marketplace. API Gateway tidak dapat mengukur atau membatasi panggilan anonim. Jika grup Anda terdaftar di Alibaba Cloud Marketplace, pindahkan API ini ke grup lain, atur visibilitasnya menjadi PRIVATE, atau gunakan autentikasi APP Alibaba Cloud.

    • APPOPENID: Mendukung autentikasi OpenID Connect pihak ketiga dan hanya mengizinkan aplikasi yang telah diotorisasi untuk memanggil API. Saat Anda memilih opsi ini, OpenIdConnectConfig wajib diisi.

    APP
    ModifiedTime

    string

    Waktu terakhir API dimodifikasi.

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

    string

    ID permintaan.

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

    string

    Deskripsi API.

    Api description
    GroupName

    string

    Nama grup yang berisi API tersebut.

    ApiTest
    GroupId

    string

    ID grup yang berisi API tersebut.

    08ae4aa0f95e4321849ee57f4e0b3077
    Mock

    string

    Menentukan apakah mode mock diaktifkan. Nilai yang valid:

    • OPEN: Mode mock diaktifkan.

    • CLOSED: Mode mock dinonaktifkan.

    CLOSED
    MockResult

    string

    Respons mock.

    test result
    CreatedTime

    string

    Waktu API dibuat.

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

    string

    Nama API. Harus unik dalam grup tersebut.

    ApiName
    BackendEnable

    boolean

    Menentukan apakah layanan backend diaktifkan.

    true
    BackendConfig

    object

    Konfigurasi backend.

    BackendId

    string

    ID layanan backend.

    0038e00c3dca44fcba3a94015d8f5bbf
    BackendType

    string

    Tipe layanan backend.

    HTTP
    BackendName

    string

    Nama layanan backend.

    testoss
    RequestConfig

    object

    Konfigurasi untuk permintaan yang dikirim dari konsumen ke API Gateway.

    BodyModel

    string

    Body model.

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

    string

    Jalur API. Misalnya, jika URL lengkapnya adalah http://api.a.com:8080/object/add?key1=value1&key2=value2, jalurnya adalah /object/add.

    /api/billing/test/[type]
    RequestHttpMethod

    string

    Metode HTTP. Nilai yang valid: GET, POST, DELETE, PUT, HEAD, TRACE, PATCH, CONNECT, dan OPTIONS.

    POST
    BodyFormat

    string

    Hanya berlaku ketika RequestMode adalah MAPPING. Menentukan cara data dikirim ke server untuk permintaan POST atau PUT. Nilai yang valid: FORM (pasangan kunci-nilai) dan STREAM (aliran byte).

    Saat Anda mengirim permintaan POST atau PUT, parameter ini menentukan cara data dikirim ke server. Nilai yang valid adalah FORM dan STREAM, yang masing-masing merepresentasikan format form (pasangan kunci-nilai) dan format aliran byte.

    STREAM
    RequestMode

    string

    Mode pemetaan permintaan. Nilai yang valid: MAPPING (memetakan parameter input) dan PASSTHROUGH (meneruskan parameter input tanpa perubahan).

    MAPPING
    PostBodyDescription

    string

    Deskripsi badan permintaan.

    fwefwef
    RequestProtocol

    string

    Protokol yang didukung untuk API. Beberapa nilai dipisahkan koma, seperti HTTP,HTTPS. Nilai yang valid: HTTP dan HTTPS.

    HTTP
    EscapePathParam

    boolean

    Menentukan apakah parameter jalur harus di-escape. Jika true, parameter seperti [param] dalam jalur diperlakukan sebagai karakter literal.

    true
    ServiceConfig

    object

    Konfigurasi untuk permintaan yang dikirim dari API Gateway ke layanan backend.

    AoneAppName

    string

    Nama aplikasi Aone.

    ib-blank
    MockStatusCode

    integer

    Kode status yang dikembalikan oleh respons mock.

    200
    ContentTypeValue

    string

    Nilai header Content-Type ketika ContentTypeCatagory adalah DEFAULT atau CUSTOM.

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

    string

    Protokol yang digunakan untuk menghubungi layanan backend. Nilai yang valid: HTTP dan HTTPS.

    HTTP
    ServicePath

    string

    Jalur yang digunakan untuk memanggil layanan backend. Misalnya, jika URL lengkapnya adalah http://api.a.com:8080/object/add?key1=value1&key2=value2, jalurnya adalah /object/add.

    /object/add
    ContentTypeCatagory

    string

    Strategi untuk mengatur header Content-Type saat memanggil layanan backend HTTP:

    • DEFAULT: Gunakan nilai default yang disediakan oleh API Gateway.

    • CUSTOM: Gunakan nilai kustom.

    • CLIENT: Gunakan header Content-Type dari permintaan klien.

    CUSTOM
    ServiceAddress

    string

    Titik akhir yang digunakan untuk memanggil layanan backend. Misalnya, jika URL lengkapnya adalah http://api.a.com:8080/object/add?key1=value1&key2=value2, titik akhirnya adalah http://api.a.com:8080.

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

    string

    Menentukan apakah mode mock diaktifkan. Nilai yang valid:

    • TRUE: Mode mock diaktifkan.

    • FALSE: Mode mock dinonaktifkan.

    TRUE
    ServiceVpcEnable

    string

    Menentukan apakah channel VPC diaktifkan. Nilai yang valid:

    • TRUE: Channel VPC diaktifkan. Anda harus terlebih dahulu mengotorisasi VPC sebelum mengaktifkan fitur ini.

    • FALSE: Channel VPC dinonaktifkan.

    TRUE
    MockResult

    string

    Respons yang dikembalikan saat mode mock diaktifkan.

    test result
    ServiceHttpMethod

    string

    Metode HTTP yang digunakan untuk memanggil layanan backend. Nilai yang valid: GET, POST, DELETE, PUT, HEAD, TRACE, PATCH, CONNECT, dan OPTIONS.

    POST
    ServiceTimeout

    integer

    Periode timeout untuk layanan backend, dalam milidetik.

    1000
    MockHeaders

    object

    MockHeader

    array<object>

    Header mock.

    object

    HeaderValue

    string

    Nilai parameter header HTTP.

    86400
    HeaderName

    string

    Nama parameter header HTTP.

    Content-Length
    VpcConfig

    object

    Konfigurasi channel VPC.

    VpcId

    string

    ID VPC.

    vpc-2zeafsc3fygk1***
    VpcScheme

    string

    Protokol VPC.

    HTTP
    InstanceId

    string

    ID instans (ECS atau Server Load Balancer) di VPC.

    i-bp1h497hkijewv2***
    Port

    integer

    Nomor port instans.

    8080
    Name

    string

    Nama otorisasi VPC.

    glmall-app-test
    FunctionComputeConfig

    object

    Konfigurasi backend untuk Function Compute.

    FcType

    string

    Tipe layanan Function Compute.

    HttpTrigger
    RoleArn

    string

    ARN peran RAM yang memberikan izin kepada API Gateway untuk mengakses Function Compute.

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

    string

    Metode HTTP.

    GET
    FcBaseUrl

    string

    Jalur root layanan Function Compute.

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

    string

    Nilai header Content-Type ketika ContentTypeCatagory adalah DEFAULT atau CUSTOM.

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

    string

    Wilayah tempat Function Compute berada.

    cn-qingdao
    OnlyBusinessPath

    boolean

    Menentukan apakah hanya jalur bisnis yang diteruskan ke backend.

    false
    FunctionName

    string

    Nama fungsi Function Compute.

    edge_function
    ContentTypeCatagory

    string

    Strategi untuk mengatur header Content-Type saat memanggil layanan backend Function Compute:

    • DEFAULT: Gunakan nilai default yang disediakan oleh API Gateway.

    • CUSTOM: Gunakan nilai kustom.

    • CLIENT: Gunakan header Content-Type dari permintaan klien.

    DEFAULT
    Path

    string

    Jalur permintaan API.

    /api/offline/cacheData
    ServiceName

    string

    Nama layanan Function Compute.

    fcservicename
    Qualifier

    string

    Alias fungsi.

    2
    TriggerName

    string

    FcVersion

    string

    OssConfig

    object

    Konfigurasi backend OSS.

    Key

    string

    Jalur ke objek atau folder di OSS.

    /folder/test.json
    Action

    string

    Operasi OSS. Nilai yang valid:

    • GetObject

    • PostObject

    • DeleteObject

    • PutObject

    • HeadObject

    • GetObjectMeta

    • AppendObject

    GetObject
    OssRegionId

    string

    ID wilayah layanan OSS.

    cn-hangzhou
    BucketName

    string

    Nama bucket OSS.

    cbg-db
    EventBridgeConfig

    object

    Konfigurasi EventBridge.

    EventBus

    string

    Event bus.

    testBus
    EventSource

    string

    Sumber event.

    baas_driver
    EventBridgeRegionId

    string

    ID wilayah layanan EventBridge.

    cn-beijing
    RoleArn

    string

    ARN peran RAM yang memberikan izin kepada EventBridge.

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

    object

    Konfigurasi OpenID Connect untuk autentikasi akun pihak ketiga.

    OpenIdApiType

    string

    Mode OpenID Connect. Nilai yang valid:

    • IDTOKEN: API otorisasi yang mengeluarkan token. Saat dipilih, PublicKeyId dan PublicKey wajib diisi.

    • BUSINESS: API bisnis yang memvalidasi token. Saat dipilih, IdTokenParamName wajib diisi.

    IDTOKEN
    IdTokenParamName

    string

    Nama parameter token.

    xxx
    PublicKeyId

    string

    ID kunci publik.

    88483727556929326703309904351185815489
    PublicKey

    string

    Kunci publik.

    EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92
    ErrorCodeSamples

    object

    ErrorCodeSample

    array<object>

    Contoh kode kesalahan yang dikembalikan oleh layanan backend.

    object

    Code

    string

    Kode kesalahan.

    400
    Model

    string

    Model.

    [\"*\"]
    Message

    string

    Pesan kesalahan.

    Missing the parameter UserId
    Description

    string

    Deskripsi.

    请求缺少参数 UserId
    SystemParameters

    object

    SystemParameter

    array<object>

    Parameter sistem yang dikirim dari API Gateway ke layanan backend.

    object

    DemoValue

    string

    Nilai contoh.

    192.168.1.1
    Description

    string

    Deskripsi parameter.

    客户端IP
    ParameterName

    string

    Nama parameter sistem. Nilai yang valid: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, dan CaProxy.

    CaClientIp
    Location

    string

    Lokasi parameter. Nilai yang valid: BODY, HEAD, QUERY, dan PATH.

    HEAD
    ServiceParameterName

    string

    Nama parameter backend yang sesuai.

    clientIp
    CustomSystemParameters

    object

    CustomSystemParameter

    array<object>

    Daftar parameter sistem kustom.

    object

    DemoValue

    string

    Nilai contoh.

    192.168.1.1
    Description

    string

    Deskripsi parameter.

    客户端IP
    ParameterName

    string

    Nama parameter sistem. Nilai yang valid: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, dan CaProxy.

    CaClientIp
    Location

    string

    Lokasi parameter. Nilai yang valid: BODY, HEAD, QUERY, dan PATH.

    HEAD
    ServiceParameterName

    string

    Nama parameter backend yang sesuai.

    clientIp
    ConstantParameters

    object

    ConstantParameter

    array<object>

    Parameter konstan yang dikirim dari API Gateway ke layanan backend.

    object

    Description

    string

    Deskripsi parameter.

    constance
    Location

    string

    Lokasi parameter. Nilai yang valid: BODY, HEAD, QUERY, dan PATH.

    HEAD
    ServiceParameterName

    string

    Nama parameter backend.

    constance
    ConstantValue

    string

    Nilai parameter konstan.

    constance
    RequestParameters

    object

    RequestParameter

    array<object>

    Parameter yang dikirim dari konsumen ke API Gateway.

    object

    JsonScheme

    string

    Validasi skema JSON. Hanya berlaku ketika ParameterType adalah String.

    JSON
    MaxValue

    integer

    Nilai maksimum. Hanya berlaku ketika ParameterType adalah Int, Long, Float, atau Double.

    123456
    ArrayItemsType

    string

    Tipe elemen array.

    String
    MinValue

    integer

    Nilai minimum. Hanya berlaku ketika ParameterType adalah Int, Long, Float, atau Double.

    123456
    DocShow

    string

    Visibilitas dalam dokumentasi. Nilai yang valid: PUBLIC dan PRIVATE.

    PUBLIC
    MaxLength

    integer

    Panjang maksimum parameter. Hanya berlaku ketika ParameterType adalah String.

    123456
    DefaultValue

    string

    Nilai default.

    20
    ApiParameterName

    string

    Nama parameter.

    age
    EnumValue

    string

    Nilai diskrit yang diizinkan. Hanya berlaku ketika ParameterType adalah Int, Long, Float, Double, atau String. Pisahkan beberapa nilai dengan koma, seperti 1,2,3,4,9 atau A,B,C,E,F.

    boy,girl
    DemoValue

    string

    Nilai contoh.

    20
    Required

    string

    Menentukan apakah parameter wajib diisi. Nilai yang valid: REQUIRED dan OPTIONAL.

    OPTIONAL
    Description

    string

    Deskripsi parameter.

    年龄
    ParameterType

    string

    Tipe parameter. Nilai yang valid: String, Int, Long, Float, Double, dan Boolean.

    String
    RegularExpression

    string

    Ekspresi reguler untuk validasi parameter. Hanya berlaku ketika ParameterType adalah String.

    xxx
    MinLength

    integer

    Panjang minimum parameter. Hanya berlaku ketika ParameterType adalah String.

    123456
    DocOrder

    integer

    Urutan dalam dokumentasi.

    0
    Location

    string

    Lokasi parameter. Nilai yang valid: BODY, HEAD, QUERY, dan PATH.

    HEAD
    ServiceParameters

    object

    ServiceParameter

    array<object>

    Parameter yang dikirim gateway ke layanan backend dalam permintaan API.

    object

    Location

    string

    Lokasi parameter. Nilai yang valid: BODY, HEAD, QUERY, PATH.

    HEAD
    ParameterType

    string

    Tipe data parameter backend. Nilainya dapat berupa STRING, NUMBER, atau BOOLEAN, yang masing-masing merepresentasikan karakter, angka, dan Boolean.

    String
    ServiceParameterName

    string

    Nama parameter backend.

    clientIp
    ServiceParametersMap

    object

    ServiceParameterMap

    array<object>

    Pemetaan antara parameter yang dikirim konsumen ke gateway dan parameter yang dikirim gateway ke layanan backend.

    object

    RequestParameterName

    string

    Bersesuaian dengan nama parameter permintaan frontend. Nilai ini harus ada di RequestParametersObject dan sesuai dengan RequestParam.ApiParameterName.

    name
    ServiceParameterName

    string

    Nama parameter backend

    name
    DeployedInfos

    object

    DeployedInfo

    array<object>

    Status penerbitan API

    object

    StageName

    string

    Nama lingkungan dapat berupa RELEASE atau TEST.

    RELEASE
    EffectiveVersion

    string

    Versi efektif.

    xxx
    DeployedStatus

    string

    Status penerapan. Nilai yang valid: DEPLOYED dan NONDEPLOYED. DEPLOYED menunjukkan bahwa API telah diterapkan. NONDEPLOYED menunjukkan bahwa API belum diterapkan.

    DEPLOYED
    TagList

    object

    Tag

    array<object>

    Daftar tag

    object

    TagKey

    string

    Kunci tag

    APP
    TagValue

    string

    Nilai tag

    value3

    Contoh

    Respons sukses

    JSONformat

    {
  "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"
      }
    ]
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.