Skip to main content
API Explorer|API Explorer
Platform O&M/Cloud Monitoring/Monitoring and Alarm/SNS/SNS Operations
POSTSNS OperationsSince 5.1.8SynchronousAuth Required

CreateSNSUniversalSmsEndpoint

CreateSNSUniversalSmsEndpoint

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • smsAccessKeyIdStringRequired

      No description provided.

    • smsAccessKeySecretStringRequired

      No description provided.

    • supplierStringRequired

      No description provided.

    • additionParamMap

      Optional.

    • nameStringRequired

      The resource name.

    • descriptionString

      Optional. The resource description.

    • platformUuidString

      Optional

    • resourceUuidString

      Optional. The resource UUID.

    • tagUuidsList

      Optional. The tag UUID.

  • systemTagsList

    Optional. The system tag.

  • userTagsList

    Optional. The user tag.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventorySNSUniversalSmsEndpointInventoryRequired

    See inventory.

    • smsAccessKeyIdStringRequired

      The access key ID.

    • smsAccessKeySecretStringRequired

      The access key secret.

    • supplierStringRequired

      The SMS service supplier.

    • nameStringRequired

      The resource name.

    • uuidStringRequired

      The resource UUID.

    • descriptionStringRequired

      The resource description.

    • stateStringRequired

      当前状态。

    • platformUuidStringRequired

      平台UUID。

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • platformSNSApplicationPlatformInventoryRequired

      See #platform.

      • uuidStringRequired

        The resource UUID.

      • nameStringRequired

        The resource name.

      • descriptionStringRequired

        The resource description.

      • typeStringRequired

        The type.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

POST/zstack/v1/sns/application-endpoints/universal-sms

/zstack/v1/sns/application-endpoints/universal-sms

Operation ID

CreateSNSUniversalSmsEndpoint

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/sns/application-endpoints/universal-sms' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"smsAccessKeyId":"<smsAccessKeyId>","smsAccessKeySecret":"<smsAccessKeySecret>","supplier":"<supplier>","additionParam":{},"name":"<name>","description":"<description>","platformUuid":"<platformUuid>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "smsAccessKeyId": "smsAccessKeyId", "smsAccessKeySecret": "smsAccessKeySecret", "name": "example", "uuid": "917fe66f76b241f0843dfbd6be685fc1", "description": "description example", "type": "UniversalSms", "state": "Enabled", "platformUuid": "4eb0ceebf95b452585ebeacd647d9f35", "createDate": "Jun 13, 2024 5:28:34 PM", "lastOpDate": "Jun 13, 2024 5:28:34 PM", "connectionStatus": "UP" } }

Change History

This API has no change history records yet.

View all change history