DescribeApiGroup - - Alibaba Cloud ドキュメントセンター

この操作を呼び出して、自動的に割り当てられた第 2 レベルドメイン名、カスタムドメイン名、SSL 証明書など、API グループの詳細を照会できます。

操作説明

この操作は API プロバイダーを対象としています。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

apigateway:DescribeApiGroup

get

*ApiGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	API グループの ID。この ID はシステムによって生成され、グローバルに一意です。	523e8dc7bbe04613b5b1d726c2a7889d
Tag	array<object>	任意	ライフサイクルルールに一致するオブジェクトタグ。複数のタグを指定できます。	Key， Value
	object	任意	タグ。
Key	string	任意	タグのキー。	appname
Value	string	任意	タグの値。	test_app

レスポンスフィールド

フィールド	型	説明	例
	object
Status	string	API グループのステータス。 NORMAL：API グループは正常です。 DELETE：API グループは削除されています。	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	API グループに自動的に割り当てられる第 2 レベルドメイン名。	27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTime	string	API グループの作成時間 (UTC)。	2016-08-01T06:53:02Z
DefaultDomain	string	デフォルトのドメイン名。	mkt.api.gaore.com
CmsMonitorGroup	string	CloudMonitor アプリケーショングループ。	217008423
BillingStatus	string	API グループの課金ステータス。 NORMAL：API グループは正常です。 LOCKED：支払い遅延により API グループはロックされています。	NORMAL
TrafficLimit	integer	API グループの QPS 上限。デフォルト値は 500 です。アプリケーションを送信することで上限を引き上げることができます。	500
PassthroughHeaders	string	ヘッダーを渡すかどうかを指定します。	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	カスタムトレース設定。	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	API グループが属するリージョン。	cn-hangzhou
ModifiedTime	string	API グループの最終変更時間 (UTC)。	2016-08-01T06:54:32Z
GroupId	string	API グループの ID。この ID はシステムによって生成され、グローバルに一意です。	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	API が属するグループの名前。	NewWeather
IllegalStatus	string	API グループの有効性ステータス。有効な値： NORMAL：API グループは正常です。 LOCKED：API グループは無効なためロックされています。	NORMAL
VpcSlbIntranetDomain	string	VPC SLB ドメイン名。	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	object
DomainItem	array<object>	カスタムドメイン名の詳細。
	object	カスタムドメイン名情報。
BindStageName	string	関連付けられた API グループが実行される環境。	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	例外の原因など、ドメイン名に関する備考。	Indicates that the domain name does not have an ICP filing.
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
StageItems	object
StageInfo	array<object>	ランタイム環境情報。
	object	ランタイム環境情報。
StageId	string	環境 ID。	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	環境名。	TEST
Description	string	環境の説明。	MYTEST
CloudMarketCommodity	boolean	Alibaba Cloud Marketplace 上のプロダクト。	false
DedicatedInstanceType	string	グループが配置されている専用インスタンスのタイプ VPC 融合タイプの専用インスタンス：vpc_connect 従来のタイプの専用インスタンス：normal	normal
MigrationStatus	string	グループ移行インスタンスタスクのステータス Running Success Failed	Fail
MigrationError	string	グループ移行インスタンスタスクの失敗理由。MigrationStatus パラメーターの値が Failed の場合、この値は空ではありません。	The current instance conflicts with the target instance.
DisableInnerDomain	boolean	パブリック第 2 レベルドメイン名経由のアクセスが有効になっているかどうかを示します。有効な値： true false	false
CustomAppCodeConfig	string	カスタム AppCode 設定。	{"location":"HEADER","name":"myAppCodeHeader"}

例

成功レスポンス

JSONJSON

{
  "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": "Indicates that the domain name does not have an ICP filing.\n",
        "DomainWebSocketStatus": "CLOSE",
        "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "IsHttpRedirectToHttps": false,
        "CertificateValidStart": 1689043476000,
        "CertificateValidEnd": 2635123476000,
        "BindStageAlias": "TEST1"
      }
    ]
  },
  "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\"}"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。