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

レポートに埋め込まれていない、指定されたチケットの詳細を取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:QueryTicketInfo

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Ticket	string	必須	チケットの値。	a27a9aec-**-**-bd40-1a21ea41d7c5

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	生成されたチケットの詳細。
AccessTicket	string	注意事項。	a27a9aec-**-**-bd40-1a21ea41d7c5
CmptId	string	レポート内のコンポーネントの ID。	sfdgsds-**-**-a608-mghdgd
GlobalParam	string	グローバルパラメーター。	[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["]}]}]\n
InvalidTime	string	チケットの有効期限。	2022-01-30 03:03:49
MaxTicketNum	integer	サポートされるチケットの最大数。	9999
OrganizationId	string	組織の ID。	2fe4fbd8-**-**-b3e1-e92c7af083ea
RegisterTime	string	チケットの登録時間。	2022-01-09 22:23:49
UsedTicketNum	integer	消費されたチケットの数。	47
UserId	string	Quick BI のユーザー ID。	974e50**********9033f46
WatermarkParam	string	ウォーターマークのパラメーターを設定します。	ticket
WorksId	string	運用レポートの ID。	ccd3428c-**-**-a608-26bae29dffee
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccessTicket": "a27a9aec-****-****-bd40-1a21ea41d7c5",
    "CmptId": "sfdgsds-****-****-a608-mghdgd",
    "GlobalParam": "[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["]}]}]\\n",
    "InvalidTime": "2022-01-30 03:03:49",
    "MaxTicketNum": 9999,
    "OrganizationId": "2fe4fbd8-****-****-b3e1-e92c7af083ea",
    "RegisterTime": "2022-01-09 22:23:49",
    "UsedTicketNum": 47,
    "UserId": "974e50**********9033f46",
    "WatermarkParam": "ticket",
    "WorksId": "ccd3428c-****-****-a608-26bae29dffee"
  },
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Authorize3rdTicket.BindedWorks.Mismatch	The report bound by the ticket mismatches the actual report.
400	Authorize3rdTicket.Expired	Ticket [%s] has expired.
400	Authorize3rdTicket.HasNo.LoginToken	The request [%s] has no token.
400	Authorize3rdTicket.NotExist	Ticket %s does not exist.
400	Authorize3rdTicket.Num.Exceed	The number of tickets %s is invalid.
400	Authorize3rdTicket.Num.HasNoLeft	There is no ticket number left, please generate new ticket.
400	NoPermissionTo.Operate.Object	You are not authorized to operate the objects.

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

変更履歴

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