DescribeApiGroup - API Gateway

Menampilkan detail kelompok API tertentu, termasuk nama domain tingkat kedua yang dihasilkan sistem, nama domain kustom, dan informasi Sertifikat SSL.

Deskripsi operasi

Operasi ini ditujukan untuk penyedia 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:DescribeApiGroup

get

*ApiGroup

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
GroupId	string	Yes	ID kelompok API. ID ini dihasilkan oleh sistem dan bersifat unik secara global.	523e8dc7bbe04613b5b1d726c2a7889d
Tag	array<object>	No	Tag objek. Anda dapat menentukan beberapa tag.	Key， Value
	object	No	Sebuah tag.
Key	string	No	Kunci tag.	appname
Value	string	No	Nilai tag.	test_app

Elemen respons

Element	Type	Description	Example
	object
Status	string	Status kelompok. NORMAL: Kelompok dalam keadaan normal. DELETE: Kelompok telah dihapus.	NORMAL
CompatibleFlags	string	Daftar tag terkait. Beberapa tag dipisahkan dengan koma (,).	depart:dep1
BasePath	string	Jalur root API.	/qqq
Ipv6Status	string	Status IPv6.	UNBIND
UserLogConfig	string	Pengaturan log pengguna.	{\"requestBody\":true,\"responseBody\":true,\"queryString\":\"test\",\"requestHeaders\":\"test\",\"responseHeaders\":\"test\",\"jwtClaims\":\"test\"}
CustomerConfigs	string	Daftar item konfigurasi kustom.	removeResponseServerHeader
RequestId	string	ID permintaan.	03442A3D-3B7D-434C-8A95-A5FEB989B519
Description	string	Deskripsi kelompok API.	New weather informations.
HttpsPolicy	string	Kebijakan HTTPS.	HTTPS2_TLS1_0
SubDomain	string	Nama domain tingkat kedua yang ditetapkan sistem untuk kelompok tersebut.	27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTime	string	Waktu pembuatan, dalam UTC.	2016-08-01T06:53:02Z
DefaultDomain	string	Nama domain default.	mkt.api.gaore.com
CmsMonitorGroup	string	Kelompok aplikasi Cloud Monitor.	217008423
BillingStatus	string	Status penagihan. NORMAL: Penagihan normal. LOCKED: Kelompok dikunci karena pembayaran tertunda.	NORMAL
TrafficLimit	integer	Jumlah maksimum permintaan per detik (QPS) untuk kelompok tersebut. Nilai default adalah 500. Untuk meningkatkan batas, ajukan permintaan.	500
PassthroughHeaders	string	Header transmisi langsung.	eagleeye-rpcid,x-b3-traceid
InstanceId	string	ID instans.	apigateway-cn-v6419k43xxxxx
VpcDomain	string	Nama domain VPC.	e4**7151954acbd9f7***1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceType	string	Tipe instans. CLASSIC_SHARED: instans bersama di jaringan klasik. VPC_SHARED: instans bersama di VPC. VPC_DEDICATED: instans khusus di VPC.	VPC_SHARED
CustomTraceConfig	string	Konfigurasi jejak kustom.	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	Wilayah tempat kelompok tersebut berada.	cn-hangzhou
ModifiedTime	string	Waktu modifikasi terakhir, dalam UTC.	2016-08-01T06:54:32Z
GroupId	string	ID kelompok API. ID ini dihasilkan oleh sistem dan bersifat unik secara global.	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	Nama kelompok API.	NewWeather
IllegalStatus	string	Status penguncian akibat aktivitas ilegal. NORMAL: Kelompok dalam keadaan normal. LOCKED: Kelompok dikunci karena aktivitas ilegal.	NORMAL
VpcSlbIntranetDomain	string	Nama domain pribadi dari Instance SLB VPC.	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	object
DomainItem	array<object>	Informasi mengenai nama domain kustom.
	object	Informasi mengenai nama domain kustom.
BindStageName	string	Nama lingkungan tempat domain tersebut diikat.	TEST
DomainLegalStatus	string	Status validitas nama domain. Nilai yang valid: NORMAL: Nama domain valid. ABNORMAL: Nama domain tidak valid. Status ini memengaruhi pemanggilan API. Segera atasi masalah tersebut.	ABNORMAL
CertificateName	string	Nama Sertifikat SSL.	myCertificate
CustomDomainType	string	Tipe nama domain kustom.	intranet
DomainCNAMEStatus	string	Status resolusi CNAME nama domain. Nilai yang valid: RESOLVED: Nama domain telah diresolusi. UNRESOLVED: Nama domain belum diresolusi.	RESOLVED
WildcardDomainPatterns	string	Pola nama domain wildcard.	[\"{test}.test.com\"]
DomainBindingStatus	string	Status pengikatan nama domain kustom. Nilai yang valid: BINDING: Nama domain sedang dalam proses pengikatan. BOUND: Nama domain telah terikat.	BINDING
DomainName	string	Nama domain.	api.demo.com
DomainRemark	string	Keterangan mengenai nama domain, seperti penyebab pengecualian.	该域名未备案
DomainWebSocketStatus	string	Status nama domain yang digunakan untuk koneksi WebSocket.	CLOSE
CertificateId	string	ID Sertifikat SSL. ID ini dihasilkan secara otomatis oleh sistem dan bersifat unik.	6EF60BEC-0242-43AF-BB20-270359FB54A7
IsHttpRedirectToHttps	boolean	Menunjukkan apakah permintaan HTTP dialihkan ke HTTPS.	false
CertificateValidStart	integer	Waktu sertifikat mulai berlaku.	1689043476000
CertificateValidEnd	integer	Waktu kedaluwarsa sertifikat.	2635123476000
BindStageAlias	string	Alias lingkungan tempat nama domain tersebut diikat.	TEST1
SslVerifyDepth	integer	Kedalaman verifikasi sertifikat.	2
SslOcspEnable	boolean	Menunjukkan apakah validasi Online Certificate Status Protocol (OCSP) didukung.	true
SslOcspCacheEnable	boolean	Menunjukkan apakah caching OCSP didukung.	true
ClientCertSDnPassThrough	boolean	Menunjukkan apakah nilai ssl_client_s_dn dalam sertifikat diteruskan ke layanan backend melalui header X-Client-S-Dn.	true
StageItems	object
StageInfo	array<object>	Informasi mengenai lingkungan.
	object	Informasi mengenai lingkungan.
StageId	string	ID lingkungan.	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	Nama lingkungan.	TEST
Description	string	Deskripsi lingkungan.	MYTEST
CloudMarketCommodity	boolean	Produk Alibaba Cloud Marketplace.	false
DedicatedInstanceType	string	Tipe instans khusus tempat kelompok tersebut berada. Instans khusus terhubung VPC: vpc_connect Instans khusus lama: normal	normal
MigrationStatus	string	Status tugas migrasi kelompok ke instans lain. Running Success Fail	Fail
MigrationError	string	Penyebab kegagalan migrasi. Parameter ini dikembalikan ketika nilai MigrationStatus adalah Fail.	The current instance conflicts with the target instance.
DisableInnerDomain	boolean	Menunjukkan apakah akses dari internet melalui nama domain tingkat kedua dinonaktifkan. true: Akses dari internet melalui nama domain tingkat kedua dinonaktifkan. false: Akses dari internet melalui nama domain tingkat kedua diizinkan.	false
CustomAppCodeConfig	string	Konfigurasi AppCode kustom.	{"location":"HEADER","name":"myAppCodeHeader"}

Contoh

Respons sukses

JSONformat

{
  "Status": "NORMAL",
  "CompatibleFlags": "depart:dep1",
  "BasePath": "/qqq",
  "Ipv6Status": "UNBIND",
  "UserLogConfig": "{\\\"requestBody\\\":true,\\\"responseBody\\\":true,\\\"queryString\\\":\\\"test\\\",\\\"requestHeaders\\\":\\\"test\\\",\\\"responseHeaders\\\":\\\"test\\\",\\\"jwtClaims\\\":\\\"test\\\"}",
  "CustomerConfigs": "removeResponseServerHeader",
  "RequestId": "03442A3D-3B7D-434C-8A95-A5FEB989B519",
  "Description": "New weather informations.",
  "HttpsPolicy": "HTTPS2_TLS1_0",
  "SubDomain": "27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
  "CreatedTime": "2016-08-01T06:53:02Z",
  "DefaultDomain": "mkt.api.gaore.com",
  "CmsMonitorGroup": "217008423",
  "BillingStatus": "NORMAL",
  "TrafficLimit": 500,
  "PassthroughHeaders": "eagleeye-rpcid,x-b3-traceid",
  "InstanceId": "apigateway-cn-v6419k43xxxxx",
  "VpcDomain": "e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com",
  "InstanceType": "VPC_SHARED",
  "CustomTraceConfig": "{\\\"parameterLocation\\\":\\\"HEADER\\\",\\\"parameterName\\\":\\\"traceId\\\"}",
  "RegionId": "cn-hangzhou",
  "ModifiedTime": "2016-08-01T06:54:32Z",
  "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  "GroupName": "NewWeather",
  "IllegalStatus": "NORMAL",
  "VpcSlbIntranetDomain": "257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com",
  "CustomDomains": {
    "DomainItem": [
      {
        "BindStageName": "TEST",
        "DomainLegalStatus": "ABNORMAL",
        "CertificateName": "myCertificate",
        "CustomDomainType": "intranet",
        "DomainCNAMEStatus": "RESOLVED",
        "WildcardDomainPatterns": "[\\\"{test}.test.com\\\"]",
        "DomainBindingStatus": "BINDING",
        "DomainName": "api.demo.com",
        "DomainRemark": "该域名未备案",
        "DomainWebSocketStatus": "CLOSE",
        "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "IsHttpRedirectToHttps": false,
        "CertificateValidStart": 1689043476000,
        "CertificateValidEnd": 2635123476000,
        "BindStageAlias": "TEST1",
        "SslVerifyDepth": 2,
        "SslOcspEnable": true,
        "SslOcspCacheEnable": true,
        "ClientCertSDnPassThrough": true
      }
    ]
  },
  "StageItems": {
    "StageInfo": [
      {
        "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
        "StageName": "TEST",
        "Description": "MYTEST"
      }
    ]
  },
  "CloudMarketCommodity": false,
  "DedicatedInstanceType": "normal",
  "MigrationStatus": "Fail",
  "MigrationError": "The current instance conflicts with the target instance.",
  "DisableInnerDomain": false,
  "CustomAppCodeConfig": "{\"location\":\"HEADER\",\"name\":\"myAppCodeHeader\"}"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.