指定された API グループの詳細 (システムが生成した第 2 レベルドメイン名、カスタムドメイン名、SSL 証明書情報など) を照会します。
操作説明
この操作は API プロバイダーを対象としています。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
apigateway:DescribeApiGroup |
get |
*ApiGroup
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| GroupId |
string |
必須 |
API グループの ID。 この ID はシステムによって生成され、グローバルに一意です。 |
523e8dc7bbe04613b5b1d726c2a7889d |
| Tag |
array<object> |
任意 |
オブジェクトタグ。 複数のタグを指定できます。 |
Key， Value |
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
タグキー。 |
appname |
| Value |
string |
任意 |
タグ値。 |
test_app |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Status |
string |
グループのステータス。
|
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 |
システムによってグループに割り当てられた第 2 レベルドメイン名。 |
27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com |
| CreatedTime |
string |
作成時刻 (UTC)。 |
2016-08-01T06:53:02Z |
| DefaultDomain |
string |
デフォルトドメイン名。 |
mkt.api.gaore.com |
| CmsMonitorGroup |
string |
Cloud Monitor アプリケーショングループ。 |
217008423 |
| BillingStatus |
string |
課金ステータス。
|
NORMAL |
| TrafficLimit |
integer |
グループの 1 秒あたりの最大クエリ数 (QPS)。 デフォルト値は 500 です。 制限を増やすには、リクエストを送信してください。 |
500 |
| PassthroughHeaders |
string |
パススルーヘッダー。 |
eagleeye-rpcid,x-b3-traceid |
| InstanceId |
string |
インスタンス ID。 |
apigateway-cn-v6419k43xxxxx |
| VpcDomain |
string |
VPC ドメイン名。 |
e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com |
| InstanceType |
string |
インスタンスタイプ。
|
VPC_SHARED |
| CustomTraceConfig |
string |
カスタムトレース設定。 |
{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"} |
| RegionId |
string |
グループが配置されているリージョン。 |
cn-hangzhou |
| ModifiedTime |
string |
最終変更時刻 (UTC)。 |
2016-08-01T06:54:32Z |
| GroupId |
string |
API グループの ID。 この ID はシステムによって生成され、グローバルに一意です。 |
523e8dc7bbe04613b5b1d726c2a7889d |
| GroupName |
string |
API グループの名前。 |
NewWeather |
| IllegalStatus |
string |
不正行為によるロックステータス。
|
NORMAL |
| VpcSlbIntranetDomain |
string |
VPC SLB インスタンスのプライベートドメイン名。 |
257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com |
| CustomDomains |
object |
||
| DomainItem |
array<object> |
カスタムドメイン名に関する情報。 |
|
|
object |
カスタムドメイン名に関する情報。 |
||
| BindStageName |
string |
ドメイン名がバインドされている環境の名前。 |
TEST |
| DomainLegalStatus |
string |
ドメイン名の有効性ステータス。 有効値：
|
ABNORMAL |
| CertificateName |
string |
SSL 証明書の名前。 |
myCertificate |
| CustomDomainType |
string |
カスタムドメイン名のタイプ。 |
intranet |
| DomainCNAMEStatus |
string |
ドメイン名の CNAME 解決ステータス。 有効値：
|
RESOLVED |
| WildcardDomainPatterns |
string |
ワイルドカードドメイン名パターン。 |
[\"{test}.test.com\"] |
| DomainBindingStatus |
string |
カスタムドメイン名のバインドステータス。 有効値：
|
BINDING |
| DomainName |
string |
ドメイン名。 |
api.demo.com |
| DomainRemark |
string |
例外の原因など、ドメイン名に関する備考。 |
该域名未备案 |
| DomainWebSocketStatus |
string |
WebSocket 接続に使用されるドメイン名のステータス。 |
CLOSE |
| CertificateId |
string |
SSL 証明書の ID。 この 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 |
Online Certificate Status Protocol (OCSP) 検証がサポートされているかどうかを示します。 |
true |
| SslOcspCacheEnable |
boolean |
OCSP キャッシュがサポートされているかどうかを示します。 |
true |
| ClientCertSDnPassThrough |
boolean |
証明書内の `ssl_client_s_dn` 値が `X-Client-S-Dn` ヘッダーを介してバックエンドサービスに渡されるかどうかを示します。 |
true |
| StageItems |
object |
||
| StageInfo |
array<object> |
環境に関する情報。 |
|
|
object |
環境に関する情報。 |
||
| StageId |
string |
環境 ID。 |
123e8dc7bbe01613b5b1d726c2a7888e |
| StageName |
string |
環境名。 |
TEST |
| Description |
string |
環境の説明。 |
MYTEST |
| CloudMarketCommodity |
boolean |
Alibaba Cloud Marketplace プロダクト。 |
false |
| DedicatedInstanceType |
string |
グループが配置されている専用型インスタンスのタイプ。
|
normal |
| MigrationStatus |
string |
グループを別のインスタンスに移行するタスクのステータス。
|
Fail |
| MigrationError |
string |
移行失敗の原因。 このパラメーターは、`MigrationStatus` の値が `Fail` の場合に返されます。 |
The current instance conflicts with the target instance. |
| DisableInnerDomain |
boolean |
第 2 レベルドメイン名を介したインターネットからのアクセスを無効にするかどうかを示します。
|
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": "该域名未备案",
"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\"}"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。