Diese Seite ist in Ihrer lokalen Sprache noch nicht verfügbar. Wir arbeiten daran, weitere Sprachversionen hinzuzufügen. Vielen Dank für Ihre Unterstützung.
Obtaining Event Subscription Details
Function
This API is used to obtain the details of an event subscription.
URI
GET /v1/{project_id}/subscriptions/{subscription_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant project ID. |
subscription_id |
Yes |
String |
ID of the event subscription. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Subscription ID. |
name |
String |
Subscription name. |
description |
String |
Description of the subscription. |
type |
String |
Subscription type. Enumeration values:
|
status |
String |
Status. Enumeration values:
|
channel_id |
String |
ID of the event channel. |
channel_name |
String |
Name of the event channel. |
used |
Array of SubscriptionUsedInfo objects |
Label information. |
sources |
Array of SubscriptionSourceInfo objects |
List of subscription sources. |
targets |
Array of SubscriptionTargetInfo objects |
List of subscription targets. |
created_time |
String |
Time when the trigger is created. |
updated_time |
String |
Time when the trigger is updated. |
Parameter |
Type |
Description |
---|---|---|
resource_id |
String |
Associated resource ID. |
owner |
String |
Management tenant account. |
description |
String |
Description. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the event subscription source. |
name |
String |
Name of the event subscription source. |
provider_type |
String |
Provider type of the event subscription source. |
detail |
Object |
List of event subscription source parameters. |
filter |
Object |
Filtering rule of the event subscription source. |
created_time |
String |
Time when the event subscription is created. |
updated_time |
String |
Time when the event subscription is updated. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the event subscription target. |
name |
String |
Name of the event subscription target. |
provider_type |
String |
Provider type of the event subscription target. |
connection_id |
String |
Connection ID used by the event subscription target. Maximum: 64 |
detail |
Object |
List of event subscription target parameters. |
transform |
TransForm object |
Transform rule of the event subscription target. |
created_time |
String |
Time when the event subscription is created. |
updated_time |
String |
Time when the event subscription is updated. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Type of the transform rule. Enumeration values:
|
value |
String |
For a constant type rule, the field is the constant content definition. For a variable type rule, the field is a variable definition and the content must be a JSON object string. A maximum of 100 variables are supported, and nested structures are not supported. The variable name can contain a maximum of 64 characters. Only letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. It must start with a letter or digit and cannot start with HC.. The variable value expression can be a constant or JSONPath expression. The string length cannot exceed 1024 characters. Maximum: 1024 |
template |
String |
Template definition of the rule content when the rule is of the variable type. Defined variables can be referenced. Maximum: 2048 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 1 Maximum: 128 |
error_msg |
String |
Error message. Minimum: 1 Maximum: 512 |
error_details |
String |
Error details. Minimum: 1 Maximum: 1024 |
request_id |
String |
Request ID. Minimum: 1 Maximum: 128 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 1 Maximum: 128 |
error_msg |
String |
Error message. Minimum: 1 Maximum: 512 |
error_details |
String |
Error details. Minimum: 1 Maximum: 1024 |
request_id |
String |
Request ID. Minimum: 1 Maximum: 128 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 1 Maximum: 128 |
error_msg |
String |
Error message. Minimum: 1 Maximum: 512 |
error_details |
String |
Error details. Minimum: 1 Maximum: 1024 |
request_id |
String |
Request ID. Minimum: 1 Maximum: 128 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 1 Maximum: 128 |
error_msg |
String |
Error message. Minimum: 1 Maximum: 512 |
error_details |
String |
Error details. Minimum: 1 Maximum: 1024 |
request_id |
String |
Request ID. Minimum: 1 Maximum: 128 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 1 Maximum: 128 |
error_msg |
String |
Error message. Minimum: 1 Maximum: 512 |
error_details |
String |
Error details. Minimum: 1 Maximum: 1024 |
request_id |
String |
Request ID. Minimum: 1 Maximum: 128 |
Example Requests
None
Example Responses
Status code: 400
{ "error_code" : "EG.00014000", "error_msg" : "Bad request" }
Status code: 401
{ "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
{ "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method" }
Status code: 404
{ "error_code" : "EG.00014040", "error_msg" : "Not request resource found" }
Status code: 500
{ "error_code" : "EG.00015000", "error_msg" : "Internal Server Error" }
Status Codes
Status Code |
Description |
---|---|
200 |
Operation successful. |
400 |
Invalid request. |
401 |
Unauthorized. |
403 |
Access denied. |
404 |
Resource not found. |
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.