ListServiceInstances API と RAM 認可によるサービスインスタンスクエリ - Compute Nest

指定されたリージョンでアカウントのサービスインスタンスをクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

computenest:ListServiceInstances

list

*ServiceInstance

acs:computenest:{#regionId}:{#accountId}:serviceinstance/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
MaxResults	integer	任意	各ページで返すエントリ数。最大値: 100。デフォルト値: 20。	20
NextToken	string	任意	クエリトークン。前の API 呼び出しから返された NextToken の値に設定します。	BBBAAfu+XtuBE55iRLHEYYuojI4=
Filter	array<object>	任意	フィルター。
	object	任意	フィルター。
Value	array	任意	フィルター値のリスト。
	string	任意	フィルター値のリスト。N の値は 1 から 10 までです。	value1
Name	string	任意	フィルターの名前。1 つ以上のフィルター名を指定してリソースをクエリできます。有効な値: Name: サービスの名前。あいまい検索を実行するには、xxx 形式で値を入力します。たとえば、サービス名が My Service の場合、My または Service と入力してあいまい検索を実行できます。 ServiceInstanceName: サービスインスタンスの名前。サービスインスタンス名を 1 つ入力すると、あいまい検索が実行されます。複数のサービスインスタンス名を入力すると、term クエリが実行されます。 ServiceInstanceId: サービスインスタンス ID。 ServiceId: サービス ID。 Version: サービスバージョン。 Status: インスタンスのステータス。 DeployType: デプロイメントタイプ。 ServiceType: サービスタイプ。 OperationStartTimeBefore: Alibaba Cloud Managed Services の開始前の時刻。 OperationStartTimeAfter: Alibaba Cloud Managed Services の開始後の時刻。 OperationEndTimeBefore: Alibaba Cloud Managed Services の終了前の時刻。 OperationEndTimeAfter: Alibaba Cloud Managed Services の終了後の時刻。 OperatedServiceInstanceId: プライベートサービス配下のマネージドサービスインスタンスの ID。 OperationServiceInstanceId: 純粋なマネージドサービス配下のサービスインスタンスの ID。 EnableInstanceOps: サービスインスタンスで Alibaba Cloud Managed Services 機能が有効になっているかどうかを示します。	ServiceInstanceId
Tag	array<object>	任意	カスタムタグ。
	object	任意	カスタムタグ。
Key	string	任意	タグキー。	key1
Value	string	任意	タグの値。	value1
ResourceGroupId	string	任意	リソースグループ ID。	rg-bp67acfmxazb4p****

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のクエリのトークン。	AAAAAfu+XtuBE55iRLHEYYuojI4=
RequestId	string	リクエスト ID。	E50287CB-AABF-4877-92C0-289B339A1546
TotalCount	integer	結果の総数。	100
MaxResults	integer	ページごとに返されるエントリ数。最大値: 100。デフォルト値: 20。	20
ServiceInstances	array<object>	サービスインスタンスに関する情報。
	array<object>	サービスインスタンスに関する情報。
Name	string	サービスインスタンスの名前。	TestName
Status	string	サービスインスタンスのステータス。指定できる値: Created: サービスインスタンスが作成されました。 Deploying: サービスインスタンスはデプロイ中です。 DeployedFailed: サービスインスタンスのデプロイに失敗しました。 Deployed: サービスインスタンスがデプロイされました。 Upgrading: サービスインスタンスはアップグレード中です。 Deleting: サービスインスタンスは削除中です。 Deleted: サービスインスタンスは削除されました。 DeletedFailed: サービスインスタンスの削除に失敗しました。	Deployed
Outputs	string	サービスインスタンスの出力情報。	{"managementUrl": "http://xx.xx"}
UpdateTime	string	更新時刻。	2021-05-20T00:00:00Z
Parameters	string	サービスインスタンスのパラメーター情報。	{"param":"value"}
ServiceInstanceId	string	サービスインスタンス ID。	si-d6ab3a63ccbb4b17****
CreateTime	string	作成時刻。	2021-05-20T00:00:00Z
StatusDetail	string	サービスインスタンスのデプロイメント情報の詳細。	deploy successfully
Progress	integer	サービスインスタンスのデプロイの進行状況。単位: %。	90
Resources	string	リソースのリスト。	[{"StackId": "stack-xxx"}]
TemplateName	string	テンプレート名。	模板1
OperatedServiceInstanceId	string	Alibaba Cloud によって管理されるサービスインスタンスの ID。	si-d6ab3a63ccbb4b17****
Service	object	サービス。
Status	string	サービスステータス。	Online
PublishTime	string	公開時刻。	2021-05-21T00:00:00Z
Version	string	サービスバージョン。	1.0
DeployType	string	デプロイメントタイプ。指定できる値: ros: サービスは ROS を使用してデプロイされます。 terraform: サービスは Terraform を使用してデプロイされます。 ack: サービスは ACK を使用してデプロイされます。 spi: サービスは SPI を呼び出すことによってデプロイされます。 operation: サービスは Alibaba Cloud Managed Services を使用してデプロイされます。	ros
ServiceId	string	サービス ID。	service-0e6fca6a51a54420****
SupplierUrl	string	サービスプロバイダーの URL。	http://example.com
ServiceType	string	サービスタイプ。指定できる値: private: サービスはユーザーのアカウントにデプロイされます。 managed: サービスはサービスプロバイダーのアカウントでホストされます。 operation: サービスは Alibaba Cloud Managed Service です。	private
SupplierName	string	サービスプロバイダーの名前。	A有限公司
ServiceInfos	array<object>	サービス情報。
	object	サービス情報。
Locale	string	サービスインスタンスの言語。	zh-CN
Image	string	サービスアイコンの URL。	https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png
Name	string	サービス名。	B数据库
ShortDescription	string	サービスの概要。	B是A公司自主设计并研发的开源分布式的关系型数据库
VersionName	string	サービスプロバイダーによって定義されたカスタムバージョン名。	版本A
Commodity	object	商品仕様。
SaasBoostMetadata	string	Software as a Service (SaaS) Boost 構成のメタデータ。	{ //开启/关闭SaaS Boost绑定 "Enabled":true/false,默认为false //公网交互地址 "PublicAccessUrl":"https://example.com" }
Type	string	タイプ。指定できる値: Marketplace: Alibaba Cloud Marketplace。 Css: Lingxiao。 SaasBoost: SaaS Boost。	Marketplace
OperationStartTime	string	Alibaba Cloud Managed Services の開始時刻。	2021-12-29T06:48:56Z
OperationEndTime	string	Alibaba Cloud Managed Services の終了時刻。	2022-01-28T06:48:56Z
EnableInstanceOps	boolean	サービスインスタンスに Alibaba Cloud Managed Services 機能があるかどうかを示します。指定できる値: true: サービスインスタンスには Alibaba Cloud Managed Services 機能があります。 false: サービスインスタンスには Alibaba Cloud Managed Services 機能がありません。	true
Tags	array<object>	カスタムタグ。
	object	カスタムタグ。
Key	string	タグキー。	key1
Value	string	タグの値。	value1
Source	string	サービスインスタンスが作成されたソース。	Supplier
EndTime	string	サービスインスタンスの有効期限。	2022-01-01T12:00:00
ServiceType	string	サービスタイプ。指定できる値: private: サービスはユーザーのアカウントにデプロイされます。 managed: サービスはサービスプロバイダーのアカウントでホストされます。 operation: サービスは Alibaba Cloud Managed Service です。 poc: サービスインスタンスは試用インスタンスです。	private
PayType	string	課金方法。有効な値: Permanent: サービスは永続的に購入されます。 Subscription: サービスは Alibaba Cloud Marketplace のサブスクリプションインスタンスです。 PayAsYouGo: サービスは Alibaba Cloud Marketplace の従量課金インスタンスです。 CustomFixTime: サービスにはカスタムの固定期間があります。	Subscription
MarketInstanceId	string	Alibaba Cloud Marketplace インスタンスの ID。	5827****
ResourceGroupId	string	リソースグループ ID。	rg-aekz6scpcxxxxxx
BizStatus	string	サービスインスタンスのビジネスステータス。指定できる値: Normal: サービスインスタンスは正常に実行されています。 Renewing: サービスインスタンスは更新中です。 RenewFoiled: サービスインスタンスの更新に失敗しました。 Expired: サービスインスタンスは期限切れです。	Normal
OrderId	string	注文 ID。	2306175xxxxxxxx
SupportTrialToPrivate	boolean	試用インスタンスを通常インスタンスに変換できるかどうかを示します。	true
PolicyNames	string
GrantedPermission	object
OperationEndTime	string
PolicyNames	string

例

成功レスポンス

JSONJSON

{
  "NextToken": "AAAAAfu+XtuBE55iRLHEYYuojI4=",
  "RequestId": "E50287CB-AABF-4877-92C0-289B339A1546",
  "TotalCount": 100,
  "MaxResults": 20,
  "ServiceInstances": [
    {
      "Name": "TestName",
      "Status": "Deployed",
      "Outputs": "{\"managementUrl\": \"http://xx.xx\"}",
      "UpdateTime": "2021-05-20T00:00:00Z",
      "Parameters": "{\"param\":\"value\"}",
      "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
      "CreateTime": "2021-05-20T00:00:00Z",
      "StatusDetail": "deploy successfully",
      "Progress": 90,
      "Resources": "[{\"StackId\": \"stack-xxx\"}]",
      "TemplateName": "模板1",
      "OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
      "Service": {
        "Status": "Online",
        "PublishTime": "2021-05-21T00:00:00Z",
        "Version": "1.0",
        "DeployType": "ros",
        "ServiceId": "service-0e6fca6a51a54420****",
        "SupplierUrl": "http://example.com",
        "ServiceType": "private",
        "SupplierName": "A有限公司",
        "ServiceInfos": [
          {
            "Locale": "zh-CN",
            "Image": "https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png",
            "Name": "B数据库",
            "ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库"
          }
        ],
        "VersionName": "版本A",
        "Commodity": {
          "SaasBoostMetadata": "{\n     //开启/关闭SaaS Boost绑定\n    \"Enabled\":true/false,默认为false\n    //公网交互地址\n    \"PublicAccessUrl\":\"https://example.com\"\n}",
          "Type": "Marketplace"
        }
      },
      "OperationStartTime": "2021-12-29T06:48:56Z",
      "OperationEndTime": "2022-01-28T06:48:56Z",
      "EnableInstanceOps": true,
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "Source": "Supplier",
      "EndTime": "2022-01-01T12:00:00",
      "ServiceType": "private",
      "PayType": "Subscription",
      "MarketInstanceId": "5827****",
      "ResourceGroupId": "rg-aekz6scpcxxxxxx",
      "BizStatus": "Normal",
      "OrderId": "2306175xxxxxxxx",
      "SupportTrialToPrivate": true,
      "PolicyNames": "",
      "GrantedPermission": {
        "OperationEndTime": "",
        "PolicyNames": ""
      }
    }
  ]
}

エラーコード

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

変更履歴

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