DescribeApiGroup - 查詢 API 分組詳情 - API Gateway

查詢API分組的詳情資訊，包含分組系統自動產生的次層網域、自訂網域名及SSL認證資訊。

介面說明

此功能面向 API 提供者

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

apigateway:DescribeApiGroup

get

*ApiGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
GroupId	string	是	API 分組 ID，系統產生，全域唯一	523e8dc7bbe04613b5b1d726c2a7889d
Tag	array<object>	否	指定規則所適用的對象標籤，可設定多個。	Key， Value
	object	否	標籤
Key	string	否	標籤鍵	appname
Value	string	否	標籤值	test_app

返回參數

名稱	類型	描述	樣本值
	object
Status	string	分組狀態 NORMAL：正常 DELETE：刪除	NORMAL
CompatibleFlags	string	關聯的標籤列表，多個用逗號（,）分隔	depart:dep1
BasePath	string	api 根路徑	/qqq
Ipv6Status	string	ipv6 狀態	UNBIND
UserLogConfig	string	使用者日誌設定	{\"requestBody\":true,\"responseBody\":true,\"queryString\":\"test\",\"requestHeaders\":\"test\",\"responseHeaders\":\"test\",\"jwtClaims\":\"test\"}
CustomerConfigs	string	自訂配置項列表	removeResponseServerHeader
RequestId	string	請求 ID	03442A3D-3B7D-434C-8A95-A5FEB989B519
Description	string	API 分組描述	New weather informations.
HttpsPolicy	string	https 策略	HTTPS2_TLS1_0
SubDomain	string	系統為分組分配的次層網域	27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTime	string	建立時間，格林威治時間	2016-08-01T06:53:02Z
DefaultDomain	string	預設網域名稱	mkt.api.gaore.com
CmsMonitorGroup	string	CloudMonitor應用分組	217008423
BillingStatus	string	計費狀態 NORMAL：正常 LOCKED：欠費鎖定	NORMAL
TrafficLimit	integer	分組最高 QPS 限制，預設 500，可申請提高	500
PassthroughHeaders	string	透傳 Headers	eagleeye-rpcid,x-b3-traceid
InstanceId	string	執行個體 ID	apigateway-cn-v6419k43xxxxx
VpcDomain	string	vpc 網域名稱	e4**7151954acbd9f7***1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceType	string	執行個體類型 CLASSIC_SHARED：共用執行個體傳統網路 VPC_SHARED：共用執行個體(VPC) VPC_DEDICATED：專享執行個體(VPC)	VPC_SHARED
CustomTraceConfig	string	自訂 trace 配置	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	分組所在地區	cn-hangzhou
ModifiedTime	string	最後修改時間，格林威治時間	2016-08-01T06:54:32Z
GroupId	string	API 分組 ID，系統產生，全域唯一	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	API 分組名稱	NewWeather
IllegalStatus	string	違法鎖定 NORMAL：正常 LOCKED：違法鎖定	NORMAL
VpcSlbIntranetDomain	string	內網 VPC SLB 網域名稱	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	object
DomainItem	array<object>	自訂網域名資訊
	object	自訂網域名資訊
BindStageName	string	綁定的運行環境名稱	TEST
DomainLegalStatus	string	網域名稱合法狀態，取值： NORMAL：正常 ABNORMAL：異常，該狀態會影響 API 呼叫，需儘快解決	ABNORMAL
CertificateName	string	SSL 憑證名稱	myCertificate
CustomDomainType	string	自訂網域名類型	intranet
DomainCNAMEStatus	string	網域名稱解析情況，取值： RESOLVED：已解析 UNRESOLVED：未解析	RESOLVED
WildcardDomainPatterns	string	通配網域名稱模式	[\"{test}.test.com\"]
DomainBindingStatus	string	自訂網域名綁定狀態，取值： BINDING：正常 BOUND：未生效	BINDING
DomainName	string	網域名稱名稱	api.demo.com
DomainRemark	string	網域名稱相關備忘，如描述網域名稱異常狀態原因	該網域名稱未備案
DomainWebSocketStatus	string	使用 WebSocket 功能的網域名稱狀態	CLOSE
CertificateId	string	SSL 憑證 ID，系統自動產生唯一編號	6EF60BEC-0242-43AF-BB20-270359FB54A7
IsHttpRedirectToHttps	boolean	是否將 http 重新導向到 https	false
CertificateValidStart	integer	認證生效時間	1689043476000
CertificateValidEnd	integer	認證失效時間	2635123476000
BindStageAlias	string	綁定的運行環境別名	TEST1
SslVerifyDepth	integer	認證驗證深度	2
SslOcspEnable	boolean	是否支援 OCSP 驗證	true
SslOcspCacheEnable	boolean	是否支援 OCSP 緩衝	true
ClientCertSDnPassThrough	boolean	是否將認證中 ssl_client_s_dn 的值通過 Header 'X-Client-S-Dn' 傳輸給後端服務	true
StageItems	object
StageInfo	array<object>	運行環境資訊
	object	運行環境資訊
StageId	string	運行環境編號	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	運行環境名稱	TEST
Description	string	運行環境描述	MYTEST
CloudMarketCommodity	boolean	雲市場商品	false
DedicatedInstanceType	string	分組所在專享執行個體的類型 VPC 融合類型專享執行個體：vpc_connect 傳統類型專享執行個體：normal	normal
MigrationStatus	string	分組遷移執行個體任務狀態運行中：Running 成功：Success 失敗：Fail	Fail
MigrationError	string	分組遷移執行個體任務失敗時，失敗的原因。當 MigrationStatus 參數值為 Fail 時，不為空白。	The current instance conflicts with the target instance.
DisableInnerDomain	boolean	是否禁止公網次層網域的訪問 true：禁止公網次層網域訪問 false：允許公網次層網域訪問	false
CustomAppCodeConfig	string	自訂 AppCode 配置	{"location":"HEADER","name":"myAppCodeHeader"}

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。