DescribeCens - Cloud Enterprise Network - Alibaba Cloud ドキュメントセンター

DescribeCens 操作を呼び出して、Alibaba Cloud アカウントに属する Cloud Enterprise Network (CEN) インスタンスに関する情報をクエリできます。この情報には、インスタンスのステータス、IPv6 が有効になっているかどうか、およびアタッチされている帯域幅プランのリストが含まれます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cen:DescribeCens

get

*CenInstance

acs:cen:*:{#accountId}:ceninstance/*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	各ページに戻されるエントリの数。有効な値: 1 から 50。デフォルト値: 10。	10
ResourceGroupId	string	任意	CEN インスタンスが属するリソースグループの ID。	rg-acfm3unpnuw****
Filter	array<object>	任意	フィルター条件。最大 5 つのフィルター条件を指定できます。
	object	任意
Key	string	任意	フィルターキー。有効な値: CenId: CEN インスタンスの ID。 Name: CEN インスタンスの名前。複数のフィルター条件間の論理関係は AND です。すべてのフィルター条件を満たす必要があります。最大 5 つのフィルター条件を指定できます。	CenId
Value	array	任意	フィルター値。 Key に基づいてフィルター値を指定します。 1 つのキーに複数の値を指定できます。値間の論理関係は OR です。指定された値のいずれかを満たしていれば、リソースは一致と見なされます。フィルター条件ごとに最大 5 つのフィルター値を指定できます。	cen-0xyeagctz5sfg9****
	string	任意	フィルター値。 Key でフィルター値を指定します。 1 つの Key に複数のフィルター値を指定できます。複数の値間の関係は論理 OR です。つまり、指定された値のいずれかと一致する場合、項目はフィルター条件に一致すると見なされます。各フィルター条件では、最大 5 つのフィルター値をサポートします。	cen-44m0p68spvlrqq****
Tag	array<object>	任意	タグ。最大 20 個のタグを指定できます。
	object	任意
Key	string	任意	リソースのタグキー。タグキーは空の文字列にすることはできません。タグキーは最大 64 文字の長さで、`aliyun` または `acs:` で始めることはできません。 `http://` または `https://` を含めることはできません。最大 20 個のタグキーを指定できます。	tagtest
Value	string	任意	リソースのタグ値。タグ値は、空の文字列または最大 128 文字の文字列です。 `aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。各タグキーには対応するタグ値が必要です。最大 20 個のタグ値を指定できます。	tagtest

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	レスポンスパラメーター。
PageSize	integer	1 ページあたりに返されるエントリの数。	10
RequestId	string	リクエスト ID。	2BFA6822-240E-4E27-B4C8-AA400EF7474D
PageNumber	integer	返されたページのページ番号。	1
TotalCount	integer	返されたエントリの総数。	1
Cens	object
Cen	array<object>	CEN インスタンスのリスト。
	object	CEN インスタンスに関する情報。
Status	string	CEN インスタンスのステータス。 Creating: インスタンスは作成中です。 Active: インスタンスは実行中です。 Deleting: インスタンスは削除中です。	Active
CreationTime	string	CEN インスタンスが作成された時刻。時刻は `YYYY-MM-DDThh:mmZ` 形式で表示されます。協定世界時 (UTC) で表されます。	2019-10-22T07:44Z
Ipv6Level	string	CEN インスタンスで IPv6 が有効になっているかどうかを示します。 ENABLE: IPv6 が有効です。 DISABLED: IPv6 は無効です。	DISABLED
Description	string	CEN インスタンスの説明。	desctest
ResourceGroupId	string	CEN インスタンスが属するリソースグループの ID。	rg-acfm3unpnuw****
CenId	string	CEN インスタンスの ID。	cen-0xyeagctz5sfg9****
ProtectionLevel	string	CIDR ブロックの重複レベル。 REDUCED: CIDR ブロックは重複できますが、同じにすることはできません。	REDUCED
Name	string	CEN インスタンスの名前。	nametest
Tags	object
Tag	array<object>	CEN インスタンスにアタッチされているタグのリスト。
	object	CEN インスタンスにアタッチされているタグに関する情報。
Key	string	タグキー。	tagtest
Value	string	タグ値。	tagtest
CenBandwidthPackageIds	object
CenBandwidthPackageId	array	CEN インスタンスにアタッチされている帯域幅プランのリスト。
	string	帯域幅プランの ID。	cenbwp-4c2zaavbvh5f42****

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "2BFA6822-240E-4E27-B4C8-AA400EF7474D",
  "PageNumber": 1,
  "TotalCount": 1,
  "Cens": {
    "Cen": [
      {
        "Status": "Active",
        "CreationTime": "2019-10-22T07:44Z",
        "Ipv6Level": "DISABLED",
        "Description": "desctest",
        "ResourceGroupId": "rg-acfm3unpnuw****",
        "CenId": "cen-0xyeagctz5sfg9****",
        "ProtectionLevel": "REDUCED",
        "Name": "nametest",
        "Tags": {
          "Tag": [
            {
              "Key": "tagtest",
              "Value": "tagtest"
            }
          ]
        },
        "CenBandwidthPackageIds": {
          "CenBandwidthPackageId": [
            "cenbwp-4c2zaavbvh5f42****"
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTagKey	The tag keys are not valid.
400	InvalidTagValue	The tag values are not valid.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

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

変更履歴

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