Common request and response parameters for C100 APIs-Data Security Center(DSC)-阿里云帮助中心

This topic describes the common request and response parameters for the APIs of DataBase Audit (DBAudit) C100 instances.

Important

The OpenAPI operation used to activate a DataBase Audit instance is based on the instance-related APIs of Alibaba Cloud Billing Management OpenAPI (BSS OpenAPI). For more information, see Alibaba Cloud Billing Management API Reference.

Common request parameters

Table 1. Common request parameters

Name	Type	Required	Description
Format	String	No	The format of the response. Valid values: JSON (default) or XML.
Version	String	Yes	The API version in the YYYY-MM-DD format. Set the value to 2018-10-29.
AccessKeyId	String	Yes	The AccessKey ID used to access the service.
Signature	String	Yes	The signature string.
SignatureMethod	String	Yes	The signature method. Set the value to HMAC-SHA1.
Timestamp	String	Yes	The timestamp of the request. Use Coordinated Universal Time (UTC) in the ISO 8601 standard format: YYYY-MM-DDThh:mm:ssZ. For example, 20:00:00 on January 10, 2024 (UTC+8) is represented as 2024-01-10T12:00:00Z.
SignatureVersion	String	Yes	The version of the signature algorithm. Set the value to 1.0.
SignatureNonce	String	Yes	A unique random number to prevent replay attacks. Use a different random number for each request.
ResourceOwnerAccount	String	No	The account that owns the resource to be accessed. This is the logon username.

Example

http://yundun-dbaudit.aliyuncs.com/?Action=ListTagKeys
&TimeStamp=2024-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2018-10-29
&SignatureVersion=1.0
&Signature=Signature

Common response parameters

API responses are returned in a unified format. You can specify the response format as XML or JSON in your request. The default format is JSON. Each API call returns a unique RequestId, regardless of whether the call is successful.

A 2xx HTTP status code indicates a successful call.
A 4xx or 5xx HTTP status code indicates a failed call.

The following code shows examples of common response parameters:

XML format

<?xml version="1.0" encoding="utf-8"?> 
    <!--The root node of the result-->
    <APIName+Response>
        <!--The request ID-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--The response data-->
    </APIName+Response>

JSON format

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*The response data*/
}