ListProductsAsEndUser で製品をリスト表示 - Service Catalog

ユーザーとしてプロダクトを照会します。

操作説明

管理者から、関連するプロダクトを管理するための権限が付与されていることを確認してください。詳細については、「アクセス権限の管理」をご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

servicecatalog:ListProductsAsEndUser

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Filters	array<object>	任意	フィルター条件を指定します。
	object	任意
Key	string	任意	フィルター条件の名前を指定します。有効な値は以下のとおりです。 ProductName：プロダクト名による完全一致検索を行います。プロダクト名は大文字小文字を区別しません。 FullTextSearch：プロダクト名、プロダクト提供者、またはプロダクト説明による全文検索を行います。あいまい検索がサポートされています。	ProductName
Value	string	任意	フィルター条件の値を指定します。	DEMO-创建ECS
SortBy	string	任意	データを並べ替える際に使用するフィールドを指定します。デフォルト値は CreateTime で、プロダクトが作成された時刻を表します。	CreateTime
SortOrder	string	任意	応答結果の並べ替え方法を指定します。有効な値は以下のとおりです。 Asc：昇順で並べ替えます。 Desc（デフォルト）：降順で並べ替えます。	Desc
PageNumber	integer	任意	返されるページ番号を指定します。ページ番号は 1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりに返されるエントリ数を指定します。有効な値は 1～100 です。デフォルト値は 10 です。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターを示します。
RequestId	string	リクエストの ID を示します。	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductSummaries	array<object>	プロダクトの一覧を示します。
	object	プロダクトの情報を示します。
Description	string	プロダクトの説明を示します。	这是一个产品描述
CreateTime	string	プロダクトが作成された時刻を示します。 ISO 8601 標準に従った YYYY-MM-DDThh:mm:ssZ 形式で表示され、UTC 時間となります。	2022-04-12T06:10:37Z
ProductId	string	プロダクトの ID を示します。	prod-bp18r7q127****
ProductArn	string	Alibaba Cloud リソースネーム (ARN) を示します。	acs:servicecatalog:cn-hangzhou:146611588617**:product/prod-bp18r7q127**
ProductName	string	プロダクトの名前を示します。	DEMO-创建ECS
ProviderName	string	プロダクトの提供者を示します。	IT团队
ProductType	string	プロダクトの種類を示します。値は Ros に設定され、Resource Orchestration Service (ROS) を意味します。	Ros
HasDefaultLaunchOption	boolean	デフォルト起動オプションが存在するかどうかを示します。有効な値は以下のとおりです。 true：デフォルト起動オプションが存在します。この場合、プロダクトの起動時やプロダクトインスタンス情報の更新時に PortfolioId パラメーターは必須ではありません。 false：デフォルト起動オプションは存在しません。この場合、プロダクトの起動時やプロダクトインスタンス情報の更新時に PortfolioId パラメーターが必要です。PortfolioId パラメーターの詳細については、「ListLaunchOptions」をご参照ください。説明プロダクトが 1 つのプロダクトポートフォリオのみに追加されている場合は、デフォルト起動オプションが存在します。複数のプロダクトポートフォリオに追加されている場合は、複数の起動オプションが同時に存在しますが、デフォルト起動オプションは存在しません。	true
TemplateType	string	プロダクトテンプレートの種類を示します。有効な値は以下のとおりです。 RosTerraformTemplate：ROS がサポートする Terraform テンプレート。 RosStandardTemplate：標準の ROS テンプレート。	RosTerraformTemplate
TotalCount	integer	返されたエントリの合計数を示します。	100
PageNumber	integer	返されたページのページ番号を示します。	1
PageSize	integer	1 ページあたりに返されるエントリ数を示します。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductSummaries": [
    {
      "Description": "这是一个产品描述",
      "CreateTime": "2022-04-12T06:10:37Z",
      "ProductId": "prod-bp18r7q127****",
      "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
      "ProductName": "DEMO-创建ECS",
      "ProviderName": "IT团队",
      "ProductType": "Ros",
      "HasDefaultLaunchOption": true,
      "TemplateType": "RosTerraformTemplate"
    }
  ],
  "TotalCount": 100,
  "PageNumber": 1,
  "PageSize": 10
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	A system error occurred.

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

変更履歴

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