Referensi API DescribeApiGroup & Detail Respons - API Gateway - Alibaba Cloud - API Gateway

Mengkueri grup API yang ditentukan, 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 grup API. ID ini dihasilkan oleh sistem dan 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 grup. NORMAL: Grup normal. DELETE: Grup dihapus.	NORMAL
CompatibleFlags	string	Daftar tag yang 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 grup API.	New weather informations.
HttpsPolicy	string	Kebijakan HTTPS.	HTTPS2_TLS1_0
SubDomain	string	Nama domain tingkat kedua yang ditetapkan ke grup oleh sistem.	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	Grup aplikasi Cloud Monitor.	217008423
BillingStatus	string	Status penagihan. NORMAL: Penagihan normal. LOCKED: Grup terkunci karena pembayaran yang jatuh tempo.	NORMAL
TrafficLimit	integer	Jumlah maksimum kueri per detik (QPS) untuk grup. Nilai default adalah 500. Untuk meningkatkan batas, kirimkan permintaan.	500
PassthroughHeaders	string	Header pass-through.	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 classic. VPC_SHARED: instans bersama di VPC. VPC_DEDICATED: instans dedicated di VPC.	VPC_SHARED
CustomTraceConfig	string	Konfigurasi trace kustom.	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	Region tempat grup berada.	cn-hangzhou
ModifiedTime	string	Waktu modifikasi terakhir, dalam UTC.	2016-08-01T06:54:32Z
GroupId	string	ID grup API. ID ini dihasilkan oleh sistem dan unik secara global.	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	Nama grup API.	NewWeather
IllegalStatus	string	Status terkunci karena aktivitas ilegal. NORMAL: Grup normal. LOCKED: Grup terkunci karena aktivitas ilegal.	NORMAL
VpcSlbIntranetDomain	string	Nama domain privat instans VPC SLB.	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	object
DomainItem	array<object>	Informasi tentang nama domain kustom.
	object	Informasi tentang nama domain kustom.
BindStageName	string	The name of the environment to which the domain name is bound.	TEST
DomainLegalStatus	string	The validity status of the domain name. Valid values: NORMAL: The domain name is valid. ABNORMAL: The domain name is invalid. This status affects API calls. Resolve the issue as soon as possible.	ABNORMAL
CertificateName	string	The name of the SSL Certificate.	myCertificate
CustomDomainType	string	The type of the custom domain name.	intranet
DomainCNAMEStatus	string	The CNAME resolution status of the domain name. Valid values: RESOLVED: The domain name is resolved. UNRESOLVED: The domain name is not resolved.	RESOLVED
WildcardDomainPatterns	string	The wildcard domain name pattern.	[\"{test}.test.com\"]
DomainBindingStatus	string	The binding status of the custom domain name. Valid values: BINDING: The domain name is bound. BOUND: The binding is not in effect.	BINDING
DomainName	string	The domain name.	api.demo.com
DomainRemark	string	The remarks about the domain name, such as the cause of an exception.	该域名未备案
DomainWebSocketStatus	string	The status of the domain name that is used for WebSocket connections.	CLOSE
CertificateId	string	The ID of the SSL Certificate. The system automatically generates this unique ID.	6EF60BEC-0242-43AF-BB20-270359FB54A7
IsHttpRedirectToHttps	boolean	Indicates whether HTTP requests are redirected to HTTPS.	false
CertificateValidStart	integer	The time when the certificate becomes valid.	1689043476000
CertificateValidEnd	integer	The time when the certificate expires.	2635123476000
BindStageAlias	string	The alias of the environment to which the domain name is bound.	TEST1
SslVerifyDepth	integer		2
SslOcspEnable	boolean		true
SslOcspCacheEnable	boolean		true
ClientCertSDnPassThrough	boolean		true
StageItems	object
StageInfo	array<object>	Informasi tentang environment.
	object	Informasi tentang environment.
StageId	string	The environment ID.	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	The environment name.	TEST
Description	string	The description of the environment.	MYTEST
CloudMarketCommodity	boolean	Produk Alibaba Cloud Marketplace.	false
DedicatedInstanceType	string	Tipe instans dedicated tempat grup berada. Instans dedicated yang terhubung ke VPC: `vpc_connect` Instans dedicated lama: `normal`	normal
MigrationStatus	string	Status tugas untuk memigrasikan grup ke instans lain. `Running` `Success` `Fail`	Fail
MigrationError	string	Penyebab kegagalan migrasi. Parameter ini dikembalikan saat 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.