DescribeApi - API Gateway

Mengambil definisi API tertentu.

Deskripsi operasi

Operasi ini tersedia untuk Open 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

Parameter permintaan

Parameter	Type	Required	Description	Example
GroupId	string	No	ID grup tempat API tersebut berada.	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 dua arah: COMMON: API umum REGISTER: API pendaftaran UNREGISTER: API pembatalan pendaftaran NOTIFY: notifikasi downstream	COMMON
DisableInternet	boolean	Menentukan apakah API hanya dapat dipanggil dari jaringan internal. Nilai yang valid: true: API hanya dapat dipanggil dari jaringan internal. false: API dapat dipanggil dari internet maupun jaringan internal.	false
ResultBodyModel	string	Hasil yang dikembalikan oleh API.	{}
ResultSample	string	Contoh respons dari layanan backend.	200
AppCodeAuthType	string	Jika AuthType diatur ke APP, parameter ini tersedia. Nilai yang valid: DEFAULT: Ini adalah nilai default. Menggunakan pengaturan grup API. DISABLE: Autentikasi AppCode tidak diizinkan. HEADER: Autentikasi AppCode hanya diizinkan untuk permintaan yang membawa AppCode di header. HEADER_QUERY: Autentikasi AppCode diizinkan untuk permintaan yang membawa AppCode di header atau parameter kueri.	HEADER
AllowSignatureMethod	string	Jika AuthType diatur ke APP, Anda harus menentukan parameter ini untuk menentukan algoritma signature. Jika Anda tidak menentukan parameter ini, HmacSHA256 digunakan secara default. Nilai yang valid: HmacSHA256 HmacSHA1,HmacSHA256	HmacSHA256
RegionId	string	ID wilayah tempat API berada.	cn-qingdao
ForceNonceCheck	boolean	Menentukan apakah header X-Ca-Nonce harus disertakan dalam pemanggilan API. Header ini merupakan pengidentifikasi unik untuk permintaan, biasanya berupa UUID. API Gateway memverifikasi parameter ini untuk mencegah serangan replay. Nilai yang sama hanya dapat digunakan sekali dalam 15 menit. Nilai yang valid: true: Kolom ini diperiksa secara paksa untuk mencegah serangan replay. false: Kolom ini tidak diperiksa.	true
Visibility	string	Menentukan apakah API bersifat publik. Nilai yang valid: PUBLIC: API bersifat publik. Jika Anda memilih opsi ini, API akan ditampilkan di halaman Discover APIs di Konsol untuk semua pengguna. PRIVATE: API bersifat privat. Jika grup API tempat API tersebut berada terdaftar di Alibaba Cloud Marketplace, API tersebut tidak akan ditampilkan.	PUBLIC
FailResultSample	string	Contoh respons gagal dari layanan backend.	400
AuthType	string	Tipe autentikasi keamanan API. Nilai yang valid: APP: Hanya aplikasi yang telah diotorisasi yang dapat memanggil API. ANONYMOUS: Pemanggilan anonim diizinkan. Catatan: Siapa pun yang mendapatkan informasi layanan API dapat memanggil API ini. API Gateway tidak melakukan otentikasi identitas pada pemanggil dan tidak dapat menerapkan pembatasan kecepatan berdasarkan pengguna. Jika Anda membuat API ini publik, konfigurasikan pembatasan kecepatan untuk API tersebut. Jangan daftarkan API ANONYMOUS di Alibaba Cloud Marketplace. API Gateway tidak dapat melakukan metering atau membatasi jumlah panggilan per pemanggil. Jika grup API akan didaftarkan di Alibaba Cloud Marketplace, pindahkan API tersebut ke grup lain, atur tipenya menjadi privat, atau pilih metode autentikasi Alibaba Cloud APP. APPOPENID: OpenID Connect dan autentikasi APP digunakan. Hanya aplikasi yang telah diotorisasi yang dapat memanggil API. Jika Anda mengatur parameter ini ke nilai ini, Anda juga harus mengatur OpenIdConnectConfig.	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 tempat API tersebut berada.	ApiTest
GroupId	string	ID grup tempat API tersebut berada.	08ae4aa0f95e4321849ee57f4e0b3077
Mock	string	Menentukan apakah mode mock diaktifkan. Nilai yang valid: OPEN: Mode mock diaktifkan. CLOSED: Mode mock tidak diaktifkan.	CLOSED
MockResult	string	Respons mock.	test result
CreatedTime	string	Waktu saat API dibuat.	2016-07-28T09:50:43Z
ApiName	string	Nama API. Nama ini harus unik dalam grup API.	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 API yang dikirimkan oleh konsumen ke API Gateway.
BodyModel	string	Model body.	https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab
RequestPath	string	Jalur API. Misalnya, jika URL lengkap suatu API 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, HEADER, TRACE, PATCH, CONNECT, dan OPTIONS.	POST
BodyFormat	string	Parameter ini hanya berlaku ketika RequestMode diatur ke MAPPING. Untuk permintaan POST dan PUT, parameter ini menentukan cara data dikirim ke server. Nilai yang valid: FORM (pasangan kunci-nilai) dan STREAM (aliran byte).	STREAM
RequestMode	string	Mode permintaan. Nilai yang valid: MAPPING untuk pemetaan parameter dan PASSTHROUGH untuk transmisi langsung parameter.	MAPPING
PostBodyDescription	string	Deskripsi body.	fwefwef
RequestProtocol	string	Protokol yang didukung oleh API. Anda dapat memilih beberapa protokol. Pisahkan dengan koma (,), misalnya "HTTP,HTTPS". Nilai yang valid: HTTP dan HTTPS.	HTTP
EscapePathParam	boolean	Menentukan apakah parameter jalur di-escape. Jika parameter ini diatur ke true, `[param]` dalam jalur dianggap sebagai karakter biasa.	true
ServiceConfig	object	Konfigurasi untuk permintaan API yang dikirimkan oleh API Gateway ke layanan backend.
AoneAppName	string	Nama aplikasi AONE.	ib-blank
MockStatusCode	integer	Kode status respons mock.	200
ContentTypeValue	string	Nilai header Content-Type saat Anda memanggil layanan HTTP backend dan ContentTypeCatagory diatur ke DEFAULT atau CUSTOM.	application/x-www-form-urlencoded; charset=UTF-8
ServiceProtocol	string	Protokol layanan backend. Hanya HTTP dan HTTPS yang didukung.	HTTP
ServicePath	string	Jalur layanan backend. Misalnya, jika URL lengkap layanan backend adalah `http://api.a.com:8080/object/add?key1=value1&key2=value2`, ServicePath-nya adalah `/object/add`.	/object/add
ContentTypeCatagory	string	Kebijakan untuk mengatur nilai header Content-Type saat Anda memanggil layanan HTTP backend: DEFAULT: Gunakan nilai default API Gateway. CUSTOM: Gunakan nilai kustom. CLIENT: Gunakan header Content-Type dari permintaan klien.	CUSTOM
ServiceAddress	string	Alamat layanan backend. Misalnya, jika URL lengkap layanan backend adalah `http://api.a.com:8080/object/add?key1=value1&key2=value2`, ServiceAddress-nya 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 tidak diaktifkan.	TRUE
ServiceVpcEnable	string	Menentukan apakah channel VPC diaktifkan. Nilai yang valid: TRUE: Channel VPC diaktifkan. Anda harus menambahkan otorisasi VPC sebelum mengaktifkan channel VPC. FALSE: Channel VPC tidak diaktifkan.	TRUE
MockResult	string	Hasil yang dikembalikan dalam mode mock.	test result
ServiceHttpMethod	string	Metode HTTP yang digunakan untuk memanggil layanan backend. Nilai yang valid: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, dan OPTIONS.	POST
ServiceTimeout	integer	Periode timeout 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 di VPC, seperti Instance ECS atau Instance Server Load Balancer.	i-bp1h497hkijewv2***
Port	integer	Nomor port instans.	8080
Name	string	Nama otorisasi VPC.	glmall-app-test
FunctionComputeConfig	object	Konfigurasi backend ketika layanan backend adalah Function Compute.
FcType	string	Tipe layanan Function Compute.	HttpTrigger
RoleArn	string	ARN peran RAM yang mengotorisasi API Gateway untuk mengakses Function Compute.	acs:ram::111***:role/aliyunserviceroleforsas
Method	string	Metode permintaan.	GET
FcBaseUrl	string	Jalur root layanan Function Compute.	https://1227**64334133.ap-southeast-1-intal.fc.aliyuncs.com/201*-15/proxy/test**ice.LATEST/testHttp/
ContentTypeValue	string	Nilai header Content-Type saat Anda memanggil layanan Function Compute backend dan ContentTypeCatagory diatur ke DEFAULT atau CUSTOM.	application/x-www-form-urlencoded; charset=UTF-8
RegionId	string	Wilayah tempat Function Compute diterapkan.	cn-qingdao
OnlyBusinessPath	boolean	Menentukan apakah backend hanya menerima jalur bisnis.	false
FunctionName	string	Nama fungsi di Function Compute.	edge_function
ContentTypeCatagory	string	Kebijakan untuk mengatur nilai header Content-Type saat Anda memanggil layanan Function Compute backend: DEFAULT: Gunakan nilai default 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 di Function Compute.	fcservicename
Qualifier	string	Alias fungsi.	2
TriggerName	string		test1
FcVersion	string
OssConfig	object	Informasi tentang backend OSS.
Key	string	Jalur objek atau folder yang disimpan di OSS.	/folder/test.json
Action	string	Operasi OSS. Nilai yang valid: GetObject PostObject DeleteObject PutObject HeadObject GetObjectMeta AppendObject	GetObject
OssRegionId	string	ID wilayah tempat layanan OSS berada.	cn-hangzhou
BucketName	string	Bucket OSS.	cbg-db
EventBridgeConfig	object	Pengaturan EventBridge.
EventBus	string	Event bus.	testBus
EventSource	string	Sumber event.	baas_driver
EventBridgeRegionId	string	ID wilayah tempat layanan EventBridge berada.	cn-beijing
RoleArn	string	ARN peran RAM yang mengotorisasi API Gateway untuk mengakses EventBridge.	acs:ram::1933122015759***:role/adminoidcaliyun
OpenIdConnectConfig	object	Konfigurasi untuk OpenID Connect, yaitu layanan autentikasi identitas pihak ketiga.
OpenIdApiType	string	Mode OpenID Connect. Nilai yang valid: IDTOKEN: API otorisasi yang mengeluarkan token. Jika Anda mengatur parameter ini ke nilai ini, Anda juga harus mengatur PublicKeyId dan PublicKey. BUSINESS: API bisnis yang memverifikasi token. Jika Anda mengatur parameter ini ke nilai ini, Anda juga harus mengatur IdTokenParamName.	IDTOKEN
IdTokenParamName	string	Nama parameter yang sesuai dengan token.	xxx
PublicKeyId	string	ID kunci publik.	88483727556929326703309904351185815489
PublicKey	string	Kunci publik.	EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92
ErrorCodeSamples	object
ErrorCodeSample	array<object>	Kode kesalahan contoh 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.	The UserId parameter is missing from the request.
SystemParameters	object
SystemParameter	array<object>	Parameter sistem yang dikirimkan oleh API Gateway ke layanan backend.
	object
DemoValue	string	Nilai contoh.	192.168.1.1
Description	string	Deskripsi parameter.	Client IP Address
ParameterName	string	Nama parameter sistem. Nilai yang valid: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, dan CaProxy.	CaClientIp
Location	string	Posisi 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.	Client IP Address
ParameterName	string	Nama parameter sistem. Nilai yang valid: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, dan CaProxy.	CaClientIp
Location	string	Posisi 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 dikirimkan oleh API Gateway ke layanan backend.
	object
Description	string	Deskripsi parameter.	constance
Location	string	Posisi parameter. Nilai yang valid: BODY, HEAD, QUERY, dan PATH.	HEAD
ServiceParameterName	string	Nama parameter backend.	constance
ConstantValue	string	Nilai parameter.	constance
RequestParameters	object
RequestParameter	array<object>	Deskripsi parameter untuk permintaan API yang dikirimkan oleh konsumen ke API Gateway.
	object
JsonScheme	string	Skema JSON untuk validasi ketika ParameterType adalah String.	JSON
MaxValue	integer	Nilai maksimum parameter. Parameter ini berlaku ketika ParameterType adalah Int, Long, Float, atau Double.	123456
ArrayItemsType	string	Tipe elemen array.	String
MinValue	integer	Nilai minimum parameter. Parameter ini berlaku ketika ParameterType adalah Int, Long, Float, atau Double.	123456
DocShow	string	Menentukan apakah dokumentasi terlihat. Nilai yang valid: PUBLIC dan PRIVATE.	PUBLIC
MaxLength	integer	Panjang maksimum parameter. Parameter ini berlaku ketika ParameterType adalah String.	123456
DefaultValue	string	Nilai default.	20
ApiParameterName	string	Nama parameter.	age
EnumValue	string	Nilai yang valid untuk parameter ketika ParameterType adalah Int, Long, Float, Double, atau String. Pisahkan beberapa nilai dengan koma (,), misalnya 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.	Age
ParameterType	string	Tipe parameter. Nilai yang valid: String, Int, Long, Float, Double, dan Boolean.	String
RegularExpression	string	Ekspresi reguler yang digunakan untuk validasi ketika ParameterType adalah String.	xxx
MinLength	integer	Panjang minimum parameter. Parameter ini berlaku ketika ParameterType adalah String.	123456
DocOrder	integer	Nomor urut dalam dokumentasi.	0
Location	string	Posisi parameter. Nilai yang valid: BODY, HEAD, QUERY, dan PATH.	HEAD
ServiceParameters	object
ServiceParameter	array<object>	Deskripsi parameter untuk permintaan API yang dikirimkan oleh API Gateway ke layanan backend.
	object
Location	string	Posisi parameter. Nilai yang valid: BODY, HEAD, QUERY, dan PATH.	HEAD
ParameterType	string	Tipe data parameter backend. Nilai yang valid: STRING, NUMBER, dan BOOLEAN.	String
ServiceParameterName	string	Nama parameter backend.	clientIp
ServiceParametersMap	object
ServiceParameterMap	array<object>	Pemetaan antara parameter permintaan frontend dan parameter permintaan backend.
	object
RequestParameterName	string	Nama parameter permintaan frontend. Nilai ini harus ada dalam objek `RequestParameters` dan sesuai dengan `ApiParameterName` dari `RequestParameter`.	sex
ServiceParameterName	string	Nama parameter backend.	sex
DeployedInfos	object
DeployedInfo	array<object>	Status penerapan API.
	object
StageName	string	Nama lingkungan. Nilai yang valid: RELEASE dan TEST.	RELEASE
EffectiveVersion	string	Versi efektif.	xxx
DeployedStatus	string	Status penerapan. Nilai yang valid: DEPLOYED (diterapkan) dan NONDEPLOYED (tidak 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": "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"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.