GetIoTCloudConnectorAccessLog

更新时间:
复制 MD 格式

Retrieves the access log status for a specified cloud connector.

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

iotcc:GetIoTCloudConnectorAccessLog

get

*CloudConnector

acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}

None None

Request parameters

Parameter

Type

Required

Description

Example

IoTCloudConnectorId

string

Yes

The ID of the cloud connector instance.

iotcc-bp1odcab8tmno0hdq****

ClientToken

string

No

A client token that ensures the idempotence of the request.

Generate this value on the client side. It must be unique across requests and contain no more than 64 ASCII characters.

Note

If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. Each API request may have a different RequestId.

123e4567-e89b-12d3-a456-426655440000

DryRun

boolean

No

Specify whether to perform only a dry run of this request. Valid values:

  • true: Submit a dry-run request. The system does not return access log status information. Instead, it checks required parameters, request format, and business limits. If the check fails, the system returns the corresponding error code. If the check passes, the system returns the error code DryRunOperation.

  • false (default): Submit a normal request. After passing the check, the system returns an HTTP 2xx status code and the access log status information.

false

RegionId

string

Yes

The region ID of the cloud connector instance.

You can call the ListRegions operation to query region IDs.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The response data.

RequestId

string

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

AccessLogSlsProject

string

The Log Service project that receives access logs.

sls-setter

AccessLogSlsLogStore

string

The Logstore that receives access logs.

test

AccessLogStatus

string

The status of access logging. Valid values:

  • Opening: Enabling access logging.

  • Opened: Access logging is enabled.

  • Closed: Access logging is disabled.

  • Closing: Disabling access logging.

Opened

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "AccessLogSlsProject": "sls-setter",
  "AccessLogSlsLogStore": "test",
  "AccessLogStatus": "Opened"
}

Error codes

HTTP status code

Error code

Error message

Description

400 Forbidden.RAM Ram user does not have permission to perform this operation. The error message returned because the RAM user does not have the permissions to perform the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.