Skip to main content

Create an Access Credential

Create a cloud access credential. This API requires data source module permissions.

Endpoint: /openapi/v1/access/create

Method: POST

Request parameters

ParameterTypeRequiredDescription
nameStringYesCredential name.
typeStringYesCredential type: accessKey or role.
vendorStringYesCloud vendor: aliyun, tencent, huawei, aws, ecloud, gcp, or baidu.
accessKeyStringYesAccessKey ID.
accessKeySecretStringYesAccessKey Secret.
roleNameStringNoRole name. Required when type is role.
arnStringNoRole ARN. Required when type is role.

Request example

{
"name": "example-access",
"type": "accessKey",
"vendor": "aliyun",
"accessKey": "<accessKey>",
"accessKeySecret": "<accessKeySecret>"
}

Response parameters

ParameterTypeDescription
successBooleanWhether the request succeeded.
requestIdStringRequest ID.
data.accessIdStringID of the new access credential.

Success response

{"success": true, "requestId": "<requestId>", "data": {"accessId": "<accessId>"}}