DescribeExporterOutputList

更新时间:
复制 MD 格式

Queries the list of monitoring data exports by calling the DescribeExporterOutputList operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeExporterOutputList

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

PageNumber

integer

No

The page number. Default value: 1.

1

PageSize

integer

No

The number of records per page. Default value: 10.

10

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

0E657631-CD6C-4C24-9637-98D000B9272C

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: successful

  • false: failed

true

Code

string

The status code.

Note

The status code 200 indicates that the call was successful. Other status codes indicate that the call failed.

200

Message

string

The error message.

sucess

PageNumber

integer

The current page number.

1

Total

integer

The total number of records.

25

Datapoints

object

Datapoint

array<object>

The list of exported configurations.

array<object>

DestType

string

The service to which the monitoring data is exported.

Note

Only Log Service is supported. More services will be supported in the future.

SLS

CreateTime

integer

The time when the configuration set was created. The value is a UNIX timestamp.

1584016495498

DestName

string

The name of the configuration set.

exporterOut

ConfigJson

object

The JSON object that contains the details about the destination to which the monitoring data is exported.

ak

string

The AccessKey ID.

LTAIpY33********

endpoint

string

The Log Service endpoint to which the monitoring data is exported.

http://cn-qingdao-share.log.aliyuncs.com

logstore

string

The Logstore.

monitorlogstore

project

string

The Log Service project to which the monitoring data is exported.

exporter

Examples

Success response

JSON format

{
  "RequestId": "0E657631-CD6C-4C24-9637-98D000B9272C",
  "Success": true,
  "Code": "200",
  "Message": "sucess",
  "PageNumber": 1,
  "Total": 25,
  "Datapoints": {
    "Datapoint": [
      {
        "DestType": "SLS",
        "CreateTime": 1584016495498,
        "DestName": "exporterOut",
        "ConfigJson": {
          "ak": "LTAIpY33********",
          "endpoint": "http://cn-qingdao-share.log.aliyuncs.com",
          "logstore": "monitorlogstore",
          "project": "exporter"
        }
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 ParameterInvalid Illegal parameters.
500 InternalError The request processing has failed due to some unknown error.
403 AccessForbidden User not authorized to operate on the specified resource.
404 ResourceNotFound The specified resource is not found. The specified resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.